Invites

Retrieve invite

Retrieves an invite.

get/organization/invites/{invite_id}

Path parameters

invite_idstring required

The ID of the invite to retrieve.

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.

Changed in 3 of the 31 revisions of this API.45

May 1, 2026918e83711c9113See the full diff
- ▲
  the response property expires_at became optional for the status 200
  response-property-became-optional
- ○
  the response property projects became required for the status 200
  response-property-became-required
- ○
  the response property projects/items/id became required for the status 200
  response-property-became-required
- ○
  the response property projects/items/role became required for the status 200
  response-property-became-required
May 1, 202672f65c459c3531See the full diff
- ▲
  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 invited_at from the response with the 200 status
  response-required-property-removed
- ○
  added the required property created_at to the response with the 200 status
  response-required-property-added
Apr 28, 2026fa32d6e7d9611See the full diff
- ○
  the endpoint scheme security AdminApiKeyAuth was added to the API
  api-security-added
This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog