Skip to main content
GET
Get a company invitation

Authorizations

Api-Token
string
header
required

Server-to-server authentication. Generate a token in the admin UI at Settings → Developers → API Access. Send the raw token in the Api-Token header — there is no Bearer prefix.

Tokens can be marked read-only at creation time, in which case the API rejects any non-GET request with 403 Forbidden.

Path Parameters

id
string
required

CompanyInvitation identifier

Response

CompanyInvitation resource

email
string<email>
required
id
integer
read-only
company
object
hash
string
status
string
default:PENDING
invitedBy
object
acceptedBy
object | null
firstName
string | null
lastName
string | null
message
string | null
roles
(string | null)[]
dateCreated
string<date-time>
dateExpires
string<date-time>
dateAccepted
string<date-time> | null
role
string
isValid
any
isExpired
any