Query parameters

This reference documents every query parameter accepted by the Partners API list endpoints (GET /{version}/{tenant}/{collection}). Single-document endpoints (GET /{version}/{tenant}/{collection}/{id}) accept a subset: depth, locale, fallbackLocale, draft, select, and populate.

Parameters

limit

Type: number Required: No Default: 10 Applies to: List endpoints

Maximum number of documents to return per page.

?limit=25

page

Type: number Required: No Default: 1 Applies to: List endpoints

The page number to retrieve. Pages are 1-indexed.

?page=3

sort

Type: string Required: No Default: None (database default order) Applies to: List endpoints

Field name to sort by. Prefix with - for descending order. Separate multiple fields with commas.

?sort=startDate
?sort=-startDate
?sort=-startDate,title

where

Type: object (nested bracket notation or JSON) Required: No Default: None Applies to: List endpoints

Filter criteria using field-level operators. Can be expressed in bracket notation or as a JSON string.

Bracket notation:

?where[title][equals]=Swan Lake
?where[startDate][greater_than]=2025-10-01T00:00:00.000Z

JSON notation:

?where={"title":{"contains":"opera"}}

Logical combinators:

?where[and][0][title][contains]=Swan&where[and][1][venue][equals]=6639a1c2f3b4a5d6e7f70001
?where[or][0][title][contains]=Traviata&where[or][1][title][contains]=Swan Lake

Supported operators

Logical combinators

depth

Type: number Required: No Default: Server default (varies) Applies to: List and single-document endpoints

Controls how many levels of relationship fields are populated.

?depth=0
?depth=2

locale

Type: string Required: No Default: Default locale Applies to: List and single-document endpoints

Request content in a specific locale. Pass all to retrieve all locales as an object.

?locale=en
?locale=all

fallbackLocale

Type: string Required: No Default: Default fallback locale Applies to: List and single-document endpoints

The locale to fall back to when the requested locale does not have content for a field.

?fallbackLocale=en

draft

Type: boolean Required: No Default: false Applies to: List and single-document endpoints

When true, includes draft (unpublished) documents in the results.

?draft=true

pagination

Type: boolean Required: No Default: true Applies to: List endpoints

When false, disables pagination and returns all matching documents in a single response. Pagination metadata fields (totalPages, hasPrevPage, etc.) may be omitted.

?pagination=false

select

Type: object (nested bracket notation) Required: No Default: All fields (or collection-specific defaults; see Events reference) Applies to: List and single-document endpoints

Controls which fields are included in the response. Set field names to true to include them. The id field is always returned.

?select[title]=true&select[slug]=true
?select[tessitura][performanceId]=true

populate

Type: object (nested bracket notation) Required: No Default: None (or collection-specific defaults; see Events reference) Applies to: List and single-document endpoints

Controls which fields are included when relationship documents are populated. Keyed by collection slug.

?populate[venues][title]=true&populate[venues][city]=true
?populate[people][name]=true

whereOperators

Type: object Required: No Default: None Applies to: List endpoints

Advanced operator configuration for where clauses. Used for complex query patterns beyond the standard operators.

Summary table

Related

• How to filter results -- practical filtering examples
• How to sort and paginate -- pagination walkthrough
• How to select fields -- field selection examples
• Collections overview -- all available collections