Skip to main content
POST
Create an Organization invitation

Authorizations

Authorization
string
header
required

Microsoft Entra application token issued by the caller's Organization tenant for this multitenant API. Request the .default scope and assign the application the required GV.APIReader, GV.APIContributor, or GV.APIOwner role.

Body

application/json
email
string
required

Sign-in name or email of the person's account in the Organization's Microsoft Entra directory. Case does not matter.

Required string length: 3 - 320
expiresAt
string<date-time>
required

When the invitation stops being redeemable. Include a UTC offset, and choose a time between 5 minutes and 30 days from now, or the call returns 422.

role
enum<string>
required

Role the person gets on accepting.

Available options:
reader,
contributor,
owner

Response

Invitation created.

acceptedAt
string | null
required
createdAt
string
required
email
string
required

Address the invitation is for, in lowercase.

expiresAt
string
required

After this time the invitation cannot be accepted.

invitationUuid
string<uuid>
required
revokedAt
string | null
required
role
enum<string>
required

Role the person gets on accepting.

Available options:
reader,
contributor,
owner
status
enum<string>
required

pending can still be accepted; expired reached expiresAt unaccepted. revoked means an Owner revoked it, a newer invitation replaced it, or the person accepted another invitation or was removed.

Available options:
pending,
accepted,
expired,
revoked