Listing and Searching
This section provides an overview of how to list and search resources on the Limecraft Flow API. These principles apply to most API calls that return multiple results, such as listing productions, collections, and more.
Paging
It’s important to note that all API calls that return multiple results use paging. This means that the call may not always return all the results in one go, and in some cases, the next page must be loaded through sequential calls. To learn more about paging, please refer to the detailed information in the Paging section.
Sorting
Most API calls support sorting, which allows you to sort the results by any of the properties of the item being requested. Learn more here.
Listing interfaces
There are three interfaces for listing resources available on the API: all, query, and search.
The specific level used depends on the API call.
All
The all level simply returns all available items (with paging) without any options for filtering or querying.
Query
Query listing allows you to provide filter query parameters to refine the results.
Currently, only the fq (filter query) parameter is supported.
For more information on query listing and how to use filter queries, refer to the Query section.
Search
Search listing is the most advanced level and offers filter queries, facets, and more.
To learn more about search listing and its capabilities, refer to the Search section.