Query parameters
Query controls accepted by list and single-record Partners API endpoints
List endpoints accept filtering, sorting, pagination, field-selection, relationship, locale, and draft controls. Single-record endpoints accept the subset shown below.
Common parameters
| Parameter | List | Single | What it does |
|---|---|---|---|
depth | Yes | Yes | Controls how many levels of related records the API expands. Use 0 for IDs only. |
locale | Yes | Yes | Requests a locale, or all for all locales. |
fallbackLocale | Yes | Yes | Sets the locale used when a translated value is missing. |
draft | Yes | Yes | Includes the latest draft version when true. Defaults to false. |
select | Yes | Yes | Chooses fields on the main record. |
populate | Yes | Yes | Chooses fields on expanded related records, keyed by collection slug. |
joins | Yes | Yes | Controls collection joins, including their count and returned records. |
These parameters use nested bracket notation where appropriate:
?depth=1&locale=en
?select[title]=true&select[slug]=true
?populate[venues][title]=true&populate[venues][city]=trueIn API version 2026-02, many collections use a compact default select and populate shape. If you supply either parameter, it replaces that part of the default shape. Request every field your integration needs explicitly. Version 2025-07 does not apply the current collection defaults.
Collection joins
Use joins to include, count, or suppress records exposed through a collection join:
?joins[events][count]=true
?joins[events][limit]=5&joins[events][sort]=-startDate
?joins[events]=falseA join can accept count, limit, page, sort, and a nested where filter. Available join names depend on the collection schema. Use field discovery before you rely on one.
List-only parameters
| Parameter | Default | What it does |
|---|---|---|
limit | 10 | Sets the maximum records returned per page. |
page | 1 | Selects a page. Pages are numbered from 1. |
sort | Collection order | Sorts by one or more fields. Prefix a field with - for descending order. |
where | None | Filters standard fields. |
attributeWhere | None | Filters configured custom attributes. |
pagination | true | Set to false to request all matching records without page metadata. |
?limit=25&page=2&sort=-startDate,titleStandard-field filters
Express where filters with bracket notation. The API does not parse a JSON string assigned directly to where as a filter object.
?where[title][equals]=Swan%20Lake
?where[startDate][greater_than_equal]=2026-10-01T00:00:00.000Z
?where[and][0][status][equals]=published&where[and][1][venue][equals]=RECORD_IDCommon operators include equals, not_equals, in, contains, like, exists, greater_than, greater_than_equal, less_than, and less_than_equal. Whether an operator is meaningful depends on the field type.
Configured-attribute filters
Collections with configured custom attributes also accept attributeWhere. Prefix the configured field key with custom.:
?attributeWhere[custom.import_id][equals]=EVT-1042
?attributeWhere[custom.priority][greater_than_equal]=10Supported configured-attribute operators are equals, not_equals, in, contains, like, exists, gt, gte, lt, and lte. You can combine attributeWhere with where. Both filters must match.
Basker reserves the lower-level whereOperators option for advanced filter construction. Do not depend on its shape unless Basker support has supplied the matching contract for your integration.
Write requests
Create and update endpoints accept depth, locale, fallbackLocale, draft, select, populate, and joins for controlling the returned record. The bulk configured-field endpoints have their own targeting and draft controls. See Bulk updating configured fields.