Organisations
Read the brand of your own calls
The organisation whose brand the account's own calls use, or null, and the organisations the account belongs to that have a saved brand.
GET
/user/brandTL;DR
| Question | Answer |
|---|---|
| What does it do? | Read the brand of your own calls. |
| What does it take? | Nothing. |
| What does it return? | Status 200 with a body of type AccountBrand. |
| What can go wrong? | 401 not signed in; 429 too many requests. Every failure uses the one error envelope. |
What it does
The organisation whose brand the account's own calls use, or null, and the organisations the account belongs to that have a saved brand. An organisation key always uses its own organisation's brand.
Responses
| Status | Meaning | Body |
|---|---|---|
| 200 | The choice and the organisations to choose from. | AccountBrand |
| 401 | Not signed in. | ErrorResponse |
| 429 | Too many requests. | ErrorResponse |
Response body
A 200 answer has the type AccountBrand.
| Field | Type | Required | Description |
|---|---|---|---|
chosen | object | null | yes | The organisation whose brand and custom icons the account's own calls use, or null. |
chosen.id | string | yes | |
chosen.slug | string | yes | |
chosen.name | string | yes | |
available | object[] | yes | The organisations the account belongs to that have a saved brand or custom icons, by name. |
available[].id | string | yes | |
available[].slug | string | yes | |
available[].name | string | yes | |
available[].active | boolean | yes | True when the organisation has a saved brand and the owner's plan includes brand themes. |
available[].iconsActive | boolean | yes | True when the organisation has custom icons and the owner's plan includes them. |
See also
| Doc | Why |
|---|---|
| API reference | Every endpoint, and the error envelope |
| Schemas | Every request and response type |
| Tool reference | The operations as callable tools |