Brands / List
List brands for the current tenant
Route: /api/{tenant:minlength(2)}/v{version:apiVersion}/brands
Method: GET
Authorisation: Minimum role: USER
Response object
Response status: 200 (OK)
Response type: DTO_brand[]
Wrapper: DTO_response_wrap_get_many
Other response statuses: 400 (BadRequest), 403 (Forbidden)
Response body example
DTO_standard_filter
| Name | Type | ReadOnly | Description |
|---|---|---|---|
| channel | String | Channel | |
| sort_by_key | String | Sort by key | |
| brand_ids | Int32[] | Brand ids | |
| response_field_keys | String[] | Only return the fields specified | |
| filters | String[] | Each string needs to be structured: filters=field_key:operator:value1|value2|value3 Only used to store filters for passing along as querystring | |
| include_aggregations | Boolean | Include aggregations | |
| include_imported | Boolean | Include imported | |
| search | String | Search | |
| sort_order | ENUM sort_order | Sort order | |
| take | Int32 | Take | |
| page | Int32 | Page |
DTO_brand
| Name | Type | ReadOnly | Description |
|---|---|---|---|
| user_brands | DTO_reference_brand_user[] | User brands | |
| created_by | DTO_reference_user | ReadOnly | Created by |
| last_updated_by | DTO_reference_user | ReadOnly | Last updated by |
| id | Int32 | ReadOnly | Leave empty on input |
| name | String | Name | |
| tenant | DTO_reference | ReadOnly | Tenant |
| created | DateTime | ReadOnly | Created |
| last_updated | DateTime | ReadOnly | Last updated |
| current_user_role | brand_user_role (nullable) | ReadOnly | The current user's effective brand role on this brand, after tenant → brand short-circuit. Tenant OWNER/ADMIN and SUPER_ADMIN are projected as USER. |
| is_active | Boolean | ReadOnly | Is active |
DTO_reference_brand_user
| Name | Type | ReadOnly | Description |
|---|---|---|---|
| brand_role_enum_id | brand_user_role (nullable) | Per-brand role for the user, when this reference appears inside a brand's user_brands list. | |
| profile_pic | String | ReadOnly | Profile pic |
| String | ReadOnly | ||
| role_enum_id | tenant_user_role (nullable) | Role enum id | |
| id | Int32 | Id | |
| label | Object | ReadOnly | Label |
DTO_reference_user
| Name | Type | ReadOnly | Description |
|---|---|---|---|
| profile_pic | String | ReadOnly | Profile pic |
| String | ReadOnly | ||
| role_enum_id | tenant_user_role (nullable) | Role enum id | |
| id | Int32 | Id | |
| label | Object | ReadOnly | Label |
DTO_reference
| Name | Type | ReadOnly | Description |
|---|---|---|---|
| id | Int32 | The id of the reference | |
| label | Object | ReadOnly | Name/Label from referenced object. |
ENUM sort_order
| Value | Name | Description |
|---|---|---|
| 0 | ASC | ASC |
| 1 | DESC | DESC |
