Skip to content
Connect an agent

Organisations

Read what an organisation's big imports draw

parts, whole, or both (the default), for an import too big for one picture when the call does not say.

GET/orgs/{org}/imports

TL;DR

QuestionAnswer
What does it do?Read what an organisation's big imports draw.
What does it take?org in the path.
What does it return?Status 200 with a body of type OrganisationImportLarge.
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

parts, whole, or both (the default), for an import too big for one picture when the call does not say. A session, or a key of the organisation.

Path parameters

FieldTypeRequiredDescription
orgstringyesThe organisation's id or its slug.

Responses

StatusMeaningBody
200The choice.OrganisationImportLarge
401Not signed in.ErrorResponse
404No such organisation, or the caller is not a member of it.ErrorResponse
429Too many requests.ErrorResponse
503Organisations are not set up on this server.ErrorResponse

Response body

A 200 answer has the type OrganisationImportLarge.

FieldTypeRequiredDescription
large"parts" | "whole" | "both"yesWhat an import too big for one readable picture draws for the organisation's members, keys and agents when the call does not say: parts (an overview and one diagram per group), whole (one diagram with every arrow), or both (the default). A member's own choice wins.

See also

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