Skip to main content
View as Markdown

Invitations

List invitations addressed to the caller

GET/api/v1/invitations

Pending, unexpired invitations addressed to the caller's email across all organizations. Interactive (JWT) sessions only.

Returns
objectstringrequired
dataarrayrequired
Show child attributes
idstring · uuidrequired
organizationobjectrequired
Reference to the inviting organization
Show child attributes
idstringrequired
Inviting organization id
namestringnullable
Inviting organization name
rolestringrequired
Organization role. admin: manage members and billing, plus everything readwrite can do. readwrite: start sessions, create API keys, delete sessions. readonly: view sessions, API keys, and test results only.
inviterEmailstringnullable
Email of the inviter
createdAtstring · date-timerequired
expiresAtstring · date-timenullable

Accept an invitation

POST/api/v1/invitations/{invitationId}/accept

Accepts an invitation addressed to the caller, joining the organization with the invited role. Interactive (JWT) sessions only.

Path parameters
invitationIdstring · uuidrequired
Invitation UUID

Reject an invitation

POST/api/v1/invitations/{invitationId}/reject

Rejects (declines) an invitation addressed to the caller. Interactive (JWT) sessions only.

Path parameters
invitationIdstring · uuidrequired
Invitation UUID

List pending invitations for the organization

GET/api/v1/organizations/{id}/invitations

Returns the pending invitations for the organization. Admin only.

Path parameters
idstringrequired
Organization id
Returns
objectstringrequired
dataarrayrequired
Pending invitations only
Show child attributes
idstring · uuidrequired
emailstring · emailrequired
rolestringrequired
Organization role. admin: manage members and billing, plus everything readwrite can do. readwrite: start sessions, create API keys, delete sessions. readonly: view sessions, API keys, and test results only.
statusstringrequired
inviterstring · uuidnullable
Reference to the inviting user
createdAtstring · date-timerequired
expiresAtstring · date-timenullable

Invite a new member to the organization

POST/api/v1/organizations/{id}/invitations

Creates a pending invitation for an email with the given role. Admin only. Fails if the email already belongs to a member or already has a pending invitation.

Path parameters
idstringrequired
Organization id
Body parameters
emailstring · emailrequired
rolestringrequired
Organization role. admin: manage members and billing, plus everything readwrite can do. readwrite: start sessions, create API keys, delete sessions. readonly: view sessions, API keys, and test results only.
Returns
idstring · uuidrequired
emailstring · emailrequired
rolestringrequired
Organization role. admin: manage members and billing, plus everything readwrite can do. readwrite: start sessions, create API keys, delete sessions. readonly: view sessions, API keys, and test results only.
statusstringrequired
inviterstring · uuidnullable
Reference to the inviting user
createdAtstring · date-timerequired
expiresAtstring · date-timenullable

Revoke a pending invitation

DELETE/api/v1/organizations/{id}/invitations/{invitationId}

Revokes a pending invitation in the organization. Admin only.

Path parameters
idstringrequired
Organization id
invitationIdstring · uuidrequired
Invitation UUID