Skip to main content
All list endpoints share the same pagination, sorting, field-selection, and filtering conventions.

Pagination

Lists are paginated with two query parameters: take=all returns the maximum page size in a single page. A paginated response’s data contains:

Field selection

Pass fields with a comma-separated list to return only the fields you need:

Sorting

Pass sort with comma-separated field names. Prefix a field with - for descending order:

Filtering

Filter lists with field__operator=value query parameters. Multiple filters combine with AND by default. Two prefixes modify how a condition combines:
  • or__ — combine the condition with OR instead of AND: or__status__exact=draft
  • not__ — negate the condition: not__status__exact=cancelled
Filters address the fields of the entity you are querying, including related fields with the related__field form where the entity exposes them. Filtering on a field the entity does not have returns a validation error.