Skip to content

List sent invitations

List unexpired, unanswered invitations to an organization and its teams. Requires billing owner or organization admin access.

Parameters

#
organizationstring
Organization name or ID. A credential, named resource or sole membership can select the organization for you.

Returns

#
dataobject[]Always present
Unanswered invitations from the organization and its teams.
Show 1 attributeHide attributes
itemsobject
An unanswered invitation sent by the organization or one of its teams.
Show 11 attributesHide attributes
emailstringAlways present
Invited email, or user ID when invited by ID without email.
expires_atstring (date-time)Always present
When the invitation expires.
grant_scopestring
Resources reached by the offered grants. May be omitted.
grantsstring[]
Additional commands offered. May be omitted.
idstringAlways present
Invitation ID.
invited_bystringAlways present
Who sent the invitation.
rolestringAlways present
Offered organization role.
teamstring
Team sending a team invitation. May be omitted.
team_rolestring
Offered team role. May be omitted.
teamsstring[]
Teams included in the invitation. May be omitted.
withholdsstring[]
Commands withheld from the offered role. May be omitted.

Errors

#
CodeStatusWhat happened
invalid400An input is missing or invalid.
unauthenticated401The credential is missing, invalid, expired or revoked.
denied403The caller lacks permission for this action.
not_found404The resource is absent or inaccessible to this caller.
conflict409The request conflicts with the current resource state or an earlier request.
over_capacity409The request exceeds a resource or credential allowance.
access_list_full409The change would exceed the access-list allowance.
rate_limited429The caller's request rate exceeds its limit.
busy429Too much work is in progress to accept this request.
unknown503The outcome is unconfirmed; a change may have happened.
unavailable503The service or requested feature is unavailable.

Notes

#
  • API key permission: organization invitation view.