Organisations
List the folders made in the portal
Folders members made in the portal, so an empty folder still shows.
GET
/orgs/{org}/foldersTL;DR
| Question | Answer |
|---|---|
| What does it do? | List the folders made in the portal. |
| What does it take? | org in the path. |
| What does it return? | Status 200 with a body of type FolderRecordList. |
| 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
Folders members made in the portal, so an empty folder still shows. Folders diagrams are filed in are read from the diagrams. A folder a rule keeps from the caller is left out.
Path parameters
| Field | Type | Required | Description |
|---|---|---|---|
org | string | yes | The organisation's id or its slug. |
Responses
| Status | Meaning | Body |
|---|---|---|
| 200 | The folders. | FolderRecordList |
| 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 FolderRecordList.
| Field | Type | Required | Description |
|---|---|---|---|
items | FolderRecord[] | yes | By path, at most 500. The folders diagrams are filed in are read from the diagrams and are not listed here unless someone made them. |
items[].path | string | yes | The folder, in the form diagrams carry in their folder. |
items[].createdAt | integer | yes | Milliseconds since the epoch, when it was made. |
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 |