Skip to content
Connect an agent

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}/documents

TL;DR

QuestionAnswer
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

FieldTypeRequiredDescription
orgstringyesThe organisation's id or its slug.

Responses

StatusMeaningBody
200The placements.DocumentPlacements
401Not signed in.ErrorResponse
403Not 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
404No such organisation, diagram, placement or file, or the caller is not a member.ErrorResponse
429Too many requests.ErrorResponse
503Placing diagrams in documents is not available on this server (documents.unavailable).ErrorResponse

Response body

A 200 answer has the type DocumentPlacements.

FieldTypeRequiredDescription
placementsDocumentPlacement[]yes
placements[].idstringyes
placements[].diagramIdstringyes
placements[].diagramNamestring | nullyes
placements[].kind"slides" | "docs"yesslides for a Google Slides deck, docs for a Google Doc.
placements[].fileIdstringyes
placements[].fileNamestringyes
placements[].pageIdstring | nullyesThe slide, for a deck; null for a Doc.
placements[].status"ok" | "failing" | "gone"yesok, failing (the last send failed; lastError says why) or gone (the file or the picture is no longer there).
placements[].lastErrorstring | nullyes
placements[].lastSentAtinteger | nullyes
placements[].currentbooleanyesWhether the file shows the library's current version.
placements[].createdAtintegeryes
placements[].linkstringyesThe file in Google.

See also

DocWhy
API referenceEvery endpoint, and the error envelope
SchemasEvery request and response type
Tool referenceThe operations as callable tools