Invites

Retrieve invite

Retrieves an invite.

get/organization/invites/{invite_id}

Path parameters

invite_idstring required

The ID of the invite to retrieve.

Response

Invite retrieved successfully.

object'organization.invite' required

The object type, which is always organization.invite

idstring required

The identifier, which can be referenced in API endpoints

emailstring required

The email address of the individual to whom the invite was sent

role'owner' | 'reader' required

owner or reader

status'accepted' | 'expired' | 'pending' required

accepted,expired, or pending

created_atinteger required

The Unix timestamp (in seconds) of when the invite was sent.

expires_atinteger nullable

The Unix timestamp (in seconds) of when the invite expires.

accepted_atinteger nullable

The Unix timestamp (in seconds) of when the invite was accepted.

Changes

Changed in 4 of the 163 revisions of this API.412

Sep 25, 2026d86203de41ae5See the full diff
- ○
  added the non-success response with the status
  response-non-success-status-added
- ○
  added the non-success response with the status
  response-non-success-status-added
- ○
  added the non-success response with the status
  response-non-success-status-added
- ○
  added the non-success response with the status
  response-non-success-status-added
- ○
  added the non-success response with the status
  response-non-success-status-added
May 13, 202674cbcf73838f45See the full diff
- ▲
  the response property became optional for the status
  response-property-became-optional
- ▲
  response property accepted_at list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property expires_at list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  removed the required property from the response with the status
  response-required-property-removed
- ○
  the endpoint scheme security AdminApiKeyAuth was added to the API
  api-security-added
- ○
  the response property became required for the status
  response-property-became-required
- ○
  the response property // became required for the status
  response-property-became-required
- ○
  the response property // became required for the status
  response-property-became-required
- ○
  added the required property to the response with the status
  response-required-property-added
This revision also has 40 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Dec 18, 2024d311deacd11a1See the full diff
- ○
  added the optional property to the response with the status
  response-optional-property-added
Aug 6, 20248eca3b09b7051See the full diff
- ○
  endpoint added
  endpoint-added
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history