API Reference

Organizations

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Users

List Organization Users

Deprecated

GET/api/v1/organizations/{organization_id}/users

Add Users To Organization

PUT/api/v1/organizations/{organization_id}/users

Remove Users From Organization

DELETE/api/v1/organizations/{organization_id}/users/{member_user_id}

Assign Role To User In Organization

PUT/api/v1/organizations/{organization_id}/users/roles

List Projects By User

Deprecated

GET/api/v1/organizations/{organization_id}/users/{user_id}/projects

Add User To Project

PUT/api/v1/organizations/{organization_id}/users/{user_id}/projects

Remove User From Project

DELETE/api/v1/organizations/{organization_id}/users/{user_id}/projects/{project_id}

ModelsExpand Collapse

UserListMembersResponse = array of OrganizationMember { id, organization_id, roles, 7 more }

id: string

Unique identifier

formatuuid

organization_id: string

The organization’s ID.

formatuuid

roles: array of UserOrganizationRole { id, organization_id, role, 4 more }

The roles of the user in the organization.

id: string

Unique identifier

formatuuid

organization_id: string

The organization’s ID.

formatuuid

role: Role { id, name, permissions, 2 more }

The role.

id: string

Unique identifier

formatuuid

name: string

A name for the role.

maxLength3000

minLength1

permissions: array of object { id, access, description, 3 more }

The actual permissions of the role.

id: string

Unique identifier

formatuuid

access: boolean

Whether the permission is granted or not.

description: string

A description for the permission.

name: string

A name for the permission.

maxLength3000

minLength1

created_at: optional string

Creation datetime

formatdate-time

updated_at: optional string

Update datetime

formatdate-time

created_at: optional string

Creation datetime

formatdate-time

updated_at: optional string

Update datetime

formatdate-time

user_id: string

The user’s ID.

created_at: optional string

Creation datetime

formatdate-time

project_ids: optional array of string

The project ID scope.

updated_at: optional string

Update datetime

formatdate-time

created_at: optional string

Creation datetime

formatdate-time

email: optional string

The user’s email address.

formatemail

Deprecatedinvited_by_user_email: optional string

The email address of the user who added the user to the organization.

formatemail

invited_by_user_id: optional string

The user ID of the user who added the user to the organization.

pending: optional boolean

Whether the user’s membership is pending account signup.

updated_at: optional string

Update datetime

formatdate-time

user_id: optional string

The user’s ID.

UserAddResponse = array of OrganizationMember { id, organization_id, roles, 7 more }

id: string

Unique identifier

formatuuid

organization_id: string

The organization’s ID.

formatuuid

roles: array of UserOrganizationRole { id, organization_id, role, 4 more }

The roles of the user in the organization.

id: string

Unique identifier

formatuuid

organization_id: string

The organization’s ID.

formatuuid

role: Role { id, name, permissions, 2 more }

The role.

id: string

Unique identifier

formatuuid

name: string

A name for the role.

maxLength3000

minLength1

permissions: array of object { id, access, description, 3 more }

The actual permissions of the role.

id: string

Unique identifier

formatuuid

access: boolean

Whether the permission is granted or not.

description: string

A description for the permission.

name: string

A name for the permission.

maxLength3000

minLength1

created_at: optional string

Creation datetime

formatdate-time

updated_at: optional string

Update datetime

formatdate-time

created_at: optional string

Creation datetime

formatdate-time

updated_at: optional string

Update datetime

formatdate-time

user_id: string

The user’s ID.

created_at: optional string

Creation datetime

formatdate-time

project_ids: optional array of string

The project ID scope.

updated_at: optional string

Update datetime

formatdate-time

created_at: optional string

Creation datetime

formatdate-time

email: optional string

The user’s email address.

formatemail

Deprecatedinvited_by_user_email: optional string

The email address of the user who added the user to the organization.

formatemail

invited_by_user_id: optional string

The user ID of the user who added the user to the organization.

pending: optional boolean

Whether the user’s membership is pending account signup.

updated_at: optional string

Update datetime

formatdate-time

user_id: optional string

The user’s ID.

UserListProjectsResponse = array of object { id, name, organization_id, 3 more }

id: string

Unique identifier

formatuuid

name: string

organization_id: string

The Organization ID the project is under.

formatuuid

created_at: optional string

Creation datetime

formatdate-time

is_default: optional boolean

Whether this project is the default project for the user.

updated_at: optional string

Update datetime

formatdate-time

UserAddToProjectResponse = unknown

UserRemoveFromProjectResponse = unknown