Skip to content
Connect an agent
Organisations

List the agents connected to an organisation

The agents members connected to the organisation with a browser sign-in, newest first, with who connected each.

GET/orgs/{org}/connections

TL;DR

QuestionAnswer
What does it do?List the agents connected to an organisation.
What does it take?org in the path.
What does it return?Status 200 with a body of type OrgConnectionList.
What can go wrong?401 not signed in; 403 a member or a reader may not look (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

The agents members connected to the organisation with a browser sign-in, newest first, with who connected each. The key behind each is never shown. The owner and an admin may look.

Path parameters

FieldTypeRequiredDescription
orgstringyesThe organisation's id or its slug.

Responses

StatusMeaningBody
200The connected agents.OrgConnectionList
401Not signed in.ErrorResponse
403A member or a reader may not look (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 OrgConnectionList.

FieldTypeRequiredDescription
itemsOrgConnection[]yes
items[].idstringyes
items[].clientIdstringyesThe OAuth client id the agent registered with.
items[].clientNamestringyesThe name the agent gave itself when it registered. It is a claim, not a fact.
items[].connectedAtintegeryesMilliseconds since the epoch.
items[].lastUsedAtinteger | nullyesMilliseconds since the epoch, or null if the agent has not made a call.
items[].connectedByobjectyesThe member who approved the connection.
items[].connectedBy.userIdstringyes
items[].connectedBy.emailstringyes

See also

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