API reference · Schema
Invitation
objectstringrequiredAlways `invitation`: the type of this object
One of
invitationidstringrequiredUnique ID (`inv_…`)
ID with prefix inv_
org_idstringrequiredOrganization it belongs to
ID with prefix org_
emailstringrequiredEmail address the invitation was sent to
rolestring | nullrequiredRole the invitee gets on accepting; null when none was recorded
One of
owneradmindeveloperbillingviewerstatusstringrequired`pending` (can still be accepted until `expires_at`), `accepted`, `rejected` or `canceled`
expires_atstring (date-time)requiredWhen it expires (null: never) (ISO 8601, UTC)
inviter_user_idstringrequiredID of the inviter user
inviterobject | nullrequiredWho sent the invitation
ShowHide 3 fields of
inviterobjectstringrequiredAlways `person`
One of
personidstringrequiredThe person’s user ID (`usr_…`)
namestring | nullrequiredTheir name as they set it; null when they are no longer a member of the organization
created_atstring (date-time)requiredWhen it was created (ISO 8601, UTC)
Example
{
"object": "invitation",
"id": "inv_01jc5zq4m8k3v6x9t2w7r0b1e4",
"org_id": "org_01jc5zq4m8k3v6x9t2w7r0b1e4",
"email": "string",
"role": "owner",
"status": "pending",
"expires_at": "2026-01-01T00:00:00.000Z",
"inviter_user_id": "string",
"inviter": {
"object": "person",
"id": "string",
"name": "string"
},
"created_at": "2026-01-01T00:00:00.000Z"
}Used by
- List invitations
GET /v1/orgs/{org_id}/invitations - Invite someone by email (a pending invitation to the same address is replaced)
POST /v1/orgs/{org_id}/invitations - Cancel a pending invitation
DELETE /v1/orgs/{org_id}/invitations/{invitation_id}