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
objectstringrequireddataarrayrequiredShow child attributes
idstring · uuidrequiredorganizationobjectrequiredReference to the inviting organization
Show child attributes
idstringrequiredInviting organization id
namestringnullableInviting organization name
rolestringrequiredOrganization 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.
inviterEmailstringnullableEmail of the inviter
createdAtstring · date-timerequiredexpiresAtstring · date-timenullableAccept 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 · uuidrequiredInvitation 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 · uuidrequiredInvitation UUID
List pending invitations for the organization
GET/api/v1/organizations/{id}/invitations
Returns the pending invitations for the organization. Admin only.
Path parameters
idstringrequiredOrganization id
Returns
objectstringrequireddataarrayrequiredPending invitations only
Show child attributes
idstring · uuidrequiredemailstring · emailrequiredrolestringrequiredOrganization 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.
statusstringrequiredinviterstring · uuidnullableReference to the inviting user
createdAtstring · date-timerequiredexpiresAtstring · date-timenullableInvite 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
idstringrequiredOrganization id
Body parameters
emailstring · emailrequiredrolestringrequiredOrganization 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 · uuidrequiredemailstring · emailrequiredrolestringrequiredOrganization 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.
statusstringrequiredinviterstring · uuidnullableReference to the inviting user
createdAtstring · date-timerequiredexpiresAtstring · date-timenullableRevoke a pending invitation
DELETE/api/v1/organizations/{id}/invitations/{invitationId}
Revokes a pending invitation in the organization. Admin only.
Path parameters
idstringrequiredOrganization id
invitationIdstring · uuidrequiredInvitation UUID