Organisations
List an organisation's custom icons
The organisation's own icons, each with its org: reference, aliases, and checked picture, with whether the hosted service draws them (the owner's plan includes custom icons), whether the caller may change them, the plan, and its limit.
GET
/orgs/{org}/iconsTL;DR
| Question | Answer |
|---|---|
| What does it do? | List an organisation's custom icons. |
| What does it take? | org in the path. |
| What does it return? | Status 200 with a body of type OrgIcons. |
| What can go wrong? | 401 not signed in, or the key is not valid; 404 no such organisation, the caller is not a member of it, or the key is another organisation's; 429 too many requests; 503 organisations are not set up on this server. Every failure uses the one error envelope. |
What it does
The organisation's own icons, each with its org: reference, aliases, and checked picture, with whether the hosted service draws them (the owner's plan includes custom icons), whether the caller may change them, the plan, and its limit. Every member may read them, and so may a key of the organisation.
Path parameters
| Field | Type | Required | Description |
|---|---|---|---|
org | string | yes | The organisation's id or its slug. |
Responses
| Status | Meaning | Body |
|---|---|---|
| 200 | The icons. | OrgIcons |
| 401 | Not signed in, or the key is not valid. | ErrorResponse |
| 404 | No such organisation, the caller is not a member of it, or the key is another organisation's. | ErrorResponse |
| 429 | Too many requests. | ErrorResponse |
| 503 | Organisations are not set up on this server. | ErrorResponse |
Response body
A 200 answer has the type OrgIcons.
| Field | Type | Required | Description |
|---|---|---|---|
icons | OrgIcon[] | yes | |
icons[].name | string | yes | |
icons[].ref | string | yes | What a diagram writes to use it. |
icons[].aliases | string[] | yes | |
icons[].mediaType | "image/svg+xml" | "image/png" | yes | |
icons[].image | string | yes | The checked picture as a data: address, for a preview. |
icons[].width | number | yes | |
icons[].height | number | yes | |
icons[].bytes | integer | yes | |
icons[].updatedAt | integer | yes | Milliseconds since the epoch. |
active | boolean | yes | True when the owner's plan includes custom icons, so the hosted service draws them. |
canEdit | boolean | yes | True when the caller's role may upload, replace and delete icons. |
plan | "free" | "pro" | "enterprise" | yes | |
limit | integer | yes | How many icons the plan lets the organisation keep. |
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 |