Skip to content
Connect an agent

Organisations

Read an organisation's approval settings

"Publishing needs approval", "Public sharing needs approval", and for the owner and admins the chosen approvers.

GET/orgs/{org}/approval

TL;DR

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

"Publishing needs approval", "Public sharing needs approval", and for the owner and admins the chosen approvers. Any member may read the switches.

Path parameters

FieldTypeRequiredDescription
orgstringyesThe organisation's id or its slug.

Responses

StatusMeaningBody
200The settings.OrganisationApproval
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 OrganisationApproval.

FieldTypeRequiredDescription
publish"off" | "folders" | "all"yes
foldersstring[]yesThe folders "Publishing needs approval" covers when it is folders.
sharebooleanyes
holdKeysbooleanyes"Hold organisation keys for approval too": while false, a publish or a new version made with an organisation key from the Keys tab goes in directly. An agent connection is held as its person is. The owner's setting.
approversarray | nullyesThe members chosen to approve besides the owner and the admins. Null for a caller who may not manage them.

See also

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