GET
View an invitation (client account)
Client space User accounts only For: Administrator · Permission: invitations.retrieve Conditions
  • The caller must be a member; agent accounts are refused.
Part of Invite and onboard members.

Authorizations

Authorization
string
header
required

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

Path Parameters

invitationId
string
required

Identifier of the invitation, within the current client account.

Query Parameters

response
enum<string>
default:resource

Response mode. Default resource; none answers 204 No Content.

Available options:
resource
fields
string

Comma-separated JSON keys of the root resource (id is always rendered). Available: id, email, pseudo, expired_at, profile_ids, status, accepted_at, created_at, updated_at.

include
string

Comma-separated include paths, each optionally followed by its fields in parentheses: units(id,sku),units.uomUnit(id,name). Max depth 6, max 40 paths. Available: .

Response

200 - application/json

Resource.

id

Identifier of the invitation (27-character KSUID string).

email

Email address the invitation was sent to.

pseudo

Display name reserved for the member the invitation creates, or null when none was given (the member is then named after their first and last name).

expired_at

Date and time the invitation expires (ISO 8601, UTC), 7 days after it was sent or renewed.

profile_ids
any[]

Identifiers of the profiles the person receives when accepting.

status

Effective status: pending (waiting and not past expired_at), accepted, or expired (marked expired, or past expired_at without being accepted).

accepted_at

Date and time the invitation was accepted (ISO 8601, UTC); null until then.

created_at

Date and time the record was created (ISO 8601, UTC).

updated_at

Date and time the record was last changed (ISO 8601, UTC).