Skip to main content
GET
/
organization-invites
/
{invite_id}
Get invite (admin/issuer view)
curl --request GET \
  --url https://api.example.com/organization-invites/{invite_id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "organization_id": "<string>",
  "email": "jsmith@example.com",
  "role": "<string>",
  "expires_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "issued_by": "<string>",
  "accepted_by": "<string>",
  "accepted_at": "2023-11-07T05:31:56Z",
  "revoked_by": "<string>",
  "revoked_at": "2023-11-07T05:31:56Z"
}

Authorizations

ā€‹
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

ā€‹
invite_id
string
required

Response

Invite

Single-use invite to join a organization. Minimal public/admin shape.

ā€‹
id
string
required
ā€‹
organization_id
string
required
ā€‹
email
string<email>
required
ā€‹
role
string
required
ā€‹
status
enum<string>
required
Available options:
PENDING,
ACCEPTED,
REVOKED,
EXPIRED
ā€‹
expires_at
string<date-time>
required
ā€‹
created_at
string<date-time>
required
ā€‹
updated_at
string<date-time>
required
ā€‹
issued_by
string | null
ā€‹
accepted_by
string | null
ā€‹
accepted_at
string<date-time> | null
ā€‹
revoked_by
string | null
ā€‹
revoked_at
string<date-time> | null