Organisations
List the diagrams placed in the organisation's decks and Docs
Each placed diagram with its file, whether the file shows the current version, and how the last send went.
GET
/orgs/{org}/documentsTL;DR
| Question | Answer |
|---|---|
| What does it do? | List the diagrams placed in the organisation's decks and Docs. |
| What does it take? | org in the path. |
| What does it return? | Status 200 with a body of type DocumentPlacements. |
| What can go wrong? | 401 not signed in; 403 not the owner or an admin (orgs.forbidden), the plan does not include it (plan.documents_not_included), or the origin may not make changes; 404 no such organisation, diagram, placement or file, or the caller is not a member; 429 too many requests; 503 placing diagrams in documents is not available on this server (documents.unavailable). Every failure uses the one error envelope. |
What it does
Each placed diagram with its file, whether the file shows the current version, and how the last send went. The owner and the admins only.
Path parameters
| Field | Type | Required | Description |
|---|---|---|---|
org | string | yes | The organisation's id or its slug. |
Responses
| Status | Meaning | Body |
|---|---|---|
| 200 | The placements. | DocumentPlacements |
| 401 | Not signed in. | ErrorResponse |
| 403 | Not the owner or an admin (orgs.forbidden), the plan does not include it (plan.documents_not_included), or the origin may not make changes. | ErrorResponse |
| 404 | No such organisation, diagram, placement or file, or the caller is not a member. | ErrorResponse |
| 429 | Too many requests. | ErrorResponse |
| 503 | Placing diagrams in documents is not available on this server (documents.unavailable). | ErrorResponse |
Response body
A 200 answer has the type DocumentPlacements.
| Field | Type | Required | Description |
|---|---|---|---|
placements | DocumentPlacement[] | yes | |
placements[].id | string | yes | |
placements[].diagramId | string | yes | |
placements[].diagramName | string | null | yes | |
placements[].kind | "slides" | "docs" | yes | slides for a Google Slides deck, docs for a Google Doc. |
placements[].fileId | string | yes | |
placements[].fileName | string | yes | |
placements[].pageId | string | null | yes | The slide, for a deck; null for a Doc. |
placements[].status | "ok" | "failing" | "gone" | yes | ok, failing (the last send failed; lastError says why) or gone (the file or the picture is no longer there). |
placements[].lastError | string | null | yes | |
placements[].lastSentAt | integer | null | yes | |
placements[].current | boolean | yes | Whether the file shows the library's current version. |
placements[].createdAt | integer | yes | |
placements[].link | string | yes | The file in Google. |
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 |