Skip to content
Connect an agent
Organisations

List an organisation's pending invitations

The invitations that can still be accepted.

GET/orgs/{org}/invites

TL;DR

QuestionAnswer
What does it do?List an organisation's pending invitations.
What does it take?org in the path.
What does it return?Status 200 with a body of type OrganisationInviteList.
What can go wrong?401 not signed in; 403 a member may not see invitations (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 invitations that can still be accepted. The token is never returned. The owner and an admin may look.

Path parameters

FieldTypeRequiredDescription
orgstringyesThe organisation's id or its slug.

Responses

StatusMeaningBody
200The pending invitations.OrganisationInviteList
401Not signed in.ErrorResponse
403A member may not see invitations (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 OrganisationInviteList.

FieldTypeRequiredDescription
itemsOrganisationInvite[]yes
items[].idstringyes
items[].emailstringyes
items[].role"admin" | "member" | "reader"yes
items[].createdAtintegeryesMilliseconds since the epoch.
items[].expiresAtintegeryesMilliseconds since the epoch. Seven days after it was made.

See also

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