Brands
List the brands of your organization and choose which one an endpoint works in.
Every job runs inside a brand, exactly as in the Pixii app. Most organizations have one brand; agencies and large catalogs have several. Use this endpoint to list them, then pass brand_id to any endpoint to choose the brand it works in. Omit brand_id and Pixii uses your default brand, the oldest one in your organization.
Endpoint
GET /v2/api/brandsResponse fields
| Field | Type | Description |
|---|---|---|
brands[].brand_id | number | The id to pass as brand_id. |
brands[].name | string | The brand name shown in the Pixii app. |
brands[].is_default | boolean | true on the brand used when a request has no brand_id. |
brands[].created_at | string | ISO 8601 timestamp of when the brand was created. Oldest first. |
A request with a brand_id that is not one of these ids fails with 404 and BRAND_NOT_FOUND. Every job response reports the brand_id it runs in.
Errors
| Code | HTTP | Description |
|---|---|---|
UNAUTHORIZED | 401 | Missing or invalid API key |