List Brands

GET/api/v2/brands

Use it in a workflow

Add a step and choose the Zendesk connector.
Pick the List Brands action (under Brands).
Fill in the fields below, then reference the result from later steps as {{listBrands.response.data}}.

Request

Query parameters

pageoneOf

Cursor pagination parameters using deepObject format. Use `?page[size]=50&page[after]=cursor` to paginate through results.

per_pageinteger

Number of records to return per page. Note: Default and maximum values vary by endpoint. Check endpoint-specific documentation for limits. (Marked internal-only because only used with traditional offset pagination, which is only supported for internal/bime requests)

sortstring

Field to sort results by. Prefix with `-` for descending order. When used with cursor pagination, this determines the cursor ordering. Example: `?sort=name` or `?sort=-created_at`

assignable_frominteger (int64)

Filters brands to only those assignable from the specified brand ID. A brand-separated brand is only assignable to itself, while account-separated brands are assignable to all other account-separated brands.

include_deletedboolean

When true, includes soft-deleted brands in the response.

Response

Returns 200 with an object. Read it in later steps with {{listBrands.response.data.<field>}}.

Need more? See the Zendesk guide for connection setup and behaviour shared by every action.

Was this page helpful?