GET/organization/invites/{invite_id}

Retrieve an organization invite

Retrieves an organization invite by its identifier. Use invite_id to select the invite whose email address, role, status, and project access you need to inspect.

1 parameter
invite_idstringrequired
The identifier of the organization invite to retrieve.

6 status codes
200Returns the invite object, including its identifier, email address, role, status, timestamps, and projects granted upon acceptance.
objectstringrequired
The object type, which is always `organization.invite`
Allowed:organization.invite
idstringrequired
The identifier, which can be referenced in API endpoints
emailstringrequired
The email address of the individual to whom the invite was sent
rolestringrequired
`owner` or `reader`
Allowed:ownerreader
statusstringrequired
`accepted`,`expired`, or `pending`
Allowed:acceptedexpiredpending
created_atintegerrequired
The Unix timestamp (in seconds) of when the invite was sent.
expires_atintegeroptional
The Unix timestamp (in seconds) of when the invite expires.
accepted_atintegeroptional
The Unix timestamp (in seconds) of when the invite was accepted.
projectsarray<object>required
The projects that were granted membership upon acceptance of the invite.
400Returned when the invite request is invalid.
errorobjectrequired
403Returned when the authenticated user does not have permission to retrieve the invite.
errorobjectrequired
Details about the permission error.
404Returned when the invite is not found.
errorobjectrequired
429Returned when too many management requests are made; reduce the request rate and try again later.
errorobjectrequired
500Returned when a server error prevents the invite from being retrieved.
errorobjectrequired

Error handling

A 400 is returned when the invite request is invalid, and a 403 is returned when the authenticated user lacks permission. A 404 is returned when the invite is not found; a 429 is returned when management requests are sent too frequently, and a 500 indicates a server error. The invite_id path parameter must identify the invite to retrieve.