Query Brands
Retrieve a paginated list of brands using filters and sorting.
URL
POST https://api.ads.apple.com/v1/business-brands/queryHeader Parameters
| Name | Type | Description |
|---|---|---|
X-Ap-Context Required | string |
Response Codes
| Status | Reason | Type | Description |
|---|---|---|---|
| 200 | OK Content-Type: application/json | BrandQueryResponse | |
| 400 | Bad Request Content-Type: application/json | BrandQueryResponse | |
| 401 | Unauthorized Content-Type: application/json | Error | |
| 403 | Forbidden Content-Type: application/json | Error | |
| 404 | Not Found Content-Type: application/json | Error | |
| 429 | Too Many Requests Content-Type: application/json | Error | |
| 500 | Internal Server Error Content-Type: application/json | Error |
Discussion
This endpoint returns a paginated list of brands accessible to the ad account. An empty request body returns all brands with default pagination.
The brand id returned in results corresponds to the promotedObjectId used when creating BUSINESS_BRAND campaigns.
See QueryFilterOperator for the full set of supported comparison operators.
Filterable Fields
Field | Type | Operators | Sortable | Description |
|---|---|---|---|---|
| string |
| ID of the brand. | |
| string (enum) |
| Ad serving eligibility for the brand. See Eligibility. |
The request body is a QueryRequest composed of QueryFilter conditions and QuerySort directives (QuerySortOrder), controlled by QueryPagination.
Request Body
See QueryRequest.
Field | Type | Required | Description |
|---|---|---|---|
| array | No | Filter conditions to narrow results. |
| array | No | Sort order for results (field + ASC/DESC). |
| object | No | Offset and page size. Defaults apply if omitted. |