Skip to content

Get Invitation

GET
/v1/invitations/{invitation_id}

Get a single invitation by its WorkOS ID. Tenant admin only.

invitation_id
required
Invitation Id
string

Successful Response

InvitationRead

Projection of a WorkOS invitation object.

object
id
required
Id
string
email
required
Email
string
state
required
State
string
role_slug
Any of:
string
organization_id
Any of:
string
created_at
Any of:
string format: date-time
expires_at
Any of:
string format: date-time
accepted_at
Any of:
string format: date-time
revoked_at
Any of:
string format: date-time
inviter_user_id
Any of:
string

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object