Skip to main content

Pagination

When endpoints return large datasets, such as collections, pagination helps manage the response. Use the page and take query parameters to control pagination:
  • page: Specifies the page number to retrieve. Default is 1.
  • take: Specifies the number of records per page. Default is 100.
To retrieve the first 50 collections in an organization, use the following query parameters:
curl --request GET \
 --url 'https://api.useinvent.com/orgs/{org_id}/assistants?page=1&take=50'

Filtering

Endpoints may support filtering to refine responses. Filtering parameters vary by endpoint. For example, the /assistants endpoint supports the following filters:
  • search: Search for a specific term within the response.
To search for assistants with the term “Issue” use the query parameters:
curl --request GET \
 --url 'https://api.useinvent.com/orgs/{org_id}/assistants?search=Issue'
Filtering parameters vary by endpoint. Refer to the endpoint documentation for the specific parameters supported.