invitations

Get an invitation

One invitation: its target workspace, role, and lifecycle. A still-pending invitation past its TTL reports status: expired, derived. members_view.

get/registry/v1/invitations/{invitation_id}

Request

  • Base URL: https://api.atlan.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.atlan.com/registry/v1/invitations/{invitation_id}
  • Auth: HTTP bearer

Path parameters

invitation_idstring required

Invitation handle (invitation_…)

Response

The invitation.

accepted_atstring nullable

Value of the accepted_at field.

created_atstring required

Value of the created_at field.

emailstring required

Value of the email field.

email_statusstring required

sent | failed | not_sent.

expires_atstring required

Value of the expires_at field.

invitation_idstring required

Stable identifier of the related invitation resource.

invited_bystring required

Value of the invited_by field.

joined_user_idstring nullable

Stable identifier of the related joined user resource.

rolestring required

Value of the role field.

sent_atstring nullable

Value of the sent_at field.

statusstring required

pending | accepted | revoked | expired (the last derived from the TTL).

workspace_idstring required

Stable identifier of the related workspace resource.

Changes

No recorded changes to this operation across all 1 revision of this API.