Skip to content
Connect an agent

Organisations

Read which apps may connect to an organisation

"Only approved apps can connect": whether it is on, the approved apps, the organisation's own apps (always allowed), and the apps seen recently.

GET/orgs/{org}/policies/apps

TL;DR

QuestionAnswer
What does it do?Read which apps may connect to an organisation.
What does it take?org in the path.
What does it return?Status 200 with a body of type AllowedAppsPolicy.
What can go wrong?401 not signed in; 403 a member or a reader (orgs.forbidden); 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

"Only approved apps can connect": whether it is on, the approved apps, the organisation's own apps (always allowed), and the apps seen recently. The owner and admins.

Path parameters

FieldTypeRequiredDescription
orgstringyesThe organisation's id or its slug.

Responses

StatusMeaningBody
200The policy.AllowedAppsPolicy
401Not signed in.ErrorResponse
403A member or a reader (orgs.forbidden).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 AllowedAppsPolicy.

FieldTypeRequiredDescription
enabledbooleanyes"Only approved apps can connect". False means any app a member approves may connect.
appsPolicyApp[]yesThe approved apps, by client id, in the order stored.
apps[].idstringyesThe app's client id.
apps[].namestring | nullyesThe name the app registered, a claim; null when no app has the id any more.
apps[].homepagestring | nullyes
apps[].ownbooleanyesTrue for the organisation's own registered app, which is always allowed.
ownPolicyApp[]yesThe organisation's own registered apps, always allowed while the policy is on.
own[].idstringyesThe app's client id.
own[].namestring | nullyesThe name the app registered, a claim; null when no app has the id any more.
own[].homepagestring | nullyes
own[].ownbooleanyesTrue for the organisation's own registered app, which is always allowed.
recentobject[]yesOther apps connected to the organisation in the last 90 days, live or ended, one each, newest first.
recent[].appPolicyAppyes
recent[].app.idstringyesThe app's client id.
recent[].app.namestring | nullyesThe name the app registered, a claim; null when no app has the id any more.
recent[].app.homepagestring | nullyes
recent[].app.ownbooleanyesTrue for the organisation's own registered app, which is always allowed.
recent[].connectionsintegeryesHow many of its connections to the organisation are live.
recent[].lastConnectedAtintegeryes

See also

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