Organisations
Read an organisation's brand theme
The saved brand colors, which of them were chosen, whether the hosted service paints with them (a brand is saved and the owner's plan includes brand themes), whether the caller may change them, and the plan.
GET
/orgs/{org}/brandTL;DR
| Question | Answer |
|---|---|
| What does it do? | Read an organisation's brand theme. |
| What does it take? | org in the path. |
| What does it return? | Status 200 with a body of type OrgBrand. |
| What can go wrong? | 401 not signed in; 404 no such organisation, or the caller is not a member of it; 429 too many requests; 503 organisations are not set up on this server. Every failure uses the one error envelope. |
What it does
The saved brand colors, which of them were chosen, whether the hosted service paints with them (a brand is saved and the owner's plan includes brand themes), whether the caller may change them, and the plan. Every member may read it.
Path parameters
| Field | Type | Required | Description |
|---|---|---|---|
org | string | yes | The organisation's id or its slug. |
Responses
| Status | Meaning | Body |
|---|---|---|
| 200 | The brand. | OrgBrand |
| 401 | Not signed in. | ErrorResponse |
| 404 | No such organisation, or the caller is not a member of it. | ErrorResponse |
| 429 | Too many requests. | ErrorResponse |
| 503 | Organisations are not set up on this server. | ErrorResponse |
Response body
A 200 answer has the type OrgBrand.
| Field | Type | Required | Description |
|---|---|---|---|
brand | BrandColors | yes | The saved brand, or null when none is saved. |
brand.primary | string | yes | Lowercase #rrggbb. |
brand.secondary | string | yes | Lowercase #rrggbb. |
brand.accent | string | yes | Lowercase #rrggbb. |
chosen | ("primary" | "secondary" | "accent")[] | yes | The colors the person chose. The others are made from the primary. |
active | boolean | yes | True when a brand is saved and the owner's plan includes brand themes, so the hosted service paints with it. |
canEdit | boolean | yes | True when the caller's role may save, remove and preview a brand: the owner and admins. |
plan | "free" | "pro" | "enterprise" | yes | The organisation's plan, which is its owner's. |
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 |