Skip to main content
GET
Get organization invitation
This endpoint requires an Admin Key with the org:read scope.

Authorizations

Authorization
string
header
required

Send the Admin API secret as a Bearer token in the Authorization header (Bearer sk-admin-***). Create Admin Keys under Console → Organization → Admin API Keys.

Path Parameters

code
string
required

Invitation code.

Response

Invitation.

code
string
required

Invitation code, returned in plain text for exact lookup / identification.

role
enum<string>
required

Organization role the invitee gets upon joining: admin or member.

Available options:
admin,
member
status
enum<string>
required

Invitation status: pending or accepted.

Available options:
pending,
accepted
invitee
string

Masked invitee contact — emails keep the first letter of the local part (e.g. a***@x.com), phone numbers keep the first 3 and last 4 digits (e.g. 138****1234). Applied consistently in list, detail, and create responses.

nick_name
string

Invitee display nickname.