Skip to main content
View as MarkdownOpenAPI spec

Organizations

List organizations the caller belongs to​

GET/api/v1/organizations
Returns
objectstringrequired
dataarrayrequired
Show child attributes
idstringrequired
The organization's own id
namestringnullable
Organization name; null for the Personal organization
typestringrequired
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.
createdAtstring · date-timerequired

Create a new organization​

POST/api/v1/organizations

Creates an organization owned by the caller (who becomes its admin). The name is required, cannot be "Personal", and cannot duplicate the name of an organization the caller already belongs to.

Body parameters
namestringrequired
Organization name; required, not "Personal", unique among the caller's organizations
Returns
idstringrequired
The organization's own id
namestringnullable
Organization name; null for the Personal organization
typestringrequired
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.
createdAtstring · date-timerequired

List organization members​

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

Returns the active members of the organization. The caller must be a member of the organization.

Path parameters
idstringrequired
Organization id
Returns
objectstringrequired
dataarrayrequired
Show child attributes
userstring · uuidrequired
Reference to the user
emailstring · emailrequired
namestringnullable
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.
joinedAtstring · date-timerequired

Rename an organization​

PATCH/api/v1/organizations/{id}

Renames the organization. Admin only. Not available for the Personal organization, nor to API keys. The name cannot be blank, cannot be "Personal", and cannot be the name of another organization the caller belongs to.

Path parameters
idstringrequired
Organization id
Body parameters
namestringrequired
New name. Same rules as create: not blank, not "Personal", not the name of another organization the caller belongs to.
Returns
idstringrequired
The organization's own id
namestringnullable
Organization name; null for the Personal organization
typestringrequired
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.
createdAtstring · date-timerequired

Delete an organization​

DELETE/api/v1/organizations/{id}

Deletes the organization. Its members and API keys can no longer use it. Admin only, and only once the caller is its sole member; refused while a plan still renews (a plan already set to cancel at period end does not block) or a device is still allocated. Not available for the Personal organization, nor to API keys.

Path parameters
idstringrequired
Organization id

Change a member's role​

PATCH/api/v1/organizations/{id}/members/{userId}

Sets another member's role. Admin only. A caller can never change their own role: every change is made by an admin who stays an admin, so an organization cannot lose its last admin. Applies on the member's next request.

Path parameters
idstringrequired
Organization id
userIdstringrequired
The member's `user` id as returned by the members list (URL-encoded), or the literal `me` for the caller.
Body parameters
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
userstring · uuidrequired
Reference to the user
emailstring · emailrequired
namestringnullable
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.
joinedAtstring · date-timerequired

Remove a member, or leave​

DELETE/api/v1/organizations/{id}/members/{userId}

Removes a member from the organization. When userId is the caller (or me) this is a leave, allowed to any member; otherwise the caller must be an admin. The last admin cannot leave: make another member an admin first, or delete the organization. The removed member's API keys for this organization stop working.

Path parameters
idstringrequired
Organization id
userIdstringrequired
The member's `user` id as returned by the members list (URL-encoded), or the literal `me` for the caller.