API Reference

Organizations

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Users

List Organization Users

client.organizations.users.listMembers(stringorganizationID, RequestOptionsoptions?): UserListMembersResponse { id, organization_id, roles, 7 more }

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

Add Users To Organization

client.organizations.users.add(stringorganizationID, UserAddParams { body } params, RequestOptionsoptions?): UserAddResponse { id, organization_id, roles, 7 more }

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

Remove Users From Organization

client.organizations.users.delete(stringmemberUserID, UserDeleteParams { organization_id, body } params, RequestOptionsoptions?): void

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

Assign Role To User In Organization

client.organizations.users.assignRole(stringorganizationID, UserAssignRoleParams { organization_id, role_id, user_id } body, RequestOptionsoptions?): UserOrganizationRole { id, organization_id, role, 4 more }

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

List Projects By User

client.organizations.users.listProjects(stringuserID, UserListProjectsParams { organization_id } params, RequestOptionsoptions?): UserListProjectsResponse { id, name, organization_id, 3 more }

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

Add User To Project

client.organizations.users.addToProject(stringuserID, UserAddToProjectParams { organization_id, project_id } params, RequestOptionsoptions?): UserAddToProjectResponse

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

Remove User From Project

client.organizations.users.removeFromProject(stringprojectID, UserRemoveFromProjectParams { organization_id, user_id } params, RequestOptionsoptions?): UserRemoveFromProjectResponse

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

ModelsExpand Collapse

UserListMembersResponse = Array<OrganizationMember { id, organization_id, roles, 7 more } >

id: string

Unique identifier

formatuuid

organization_id: string

The organization’s ID.

formatuuid

roles: Array<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<Permission>

The actual permissions of the role.

id: string

Unique identifier

formatuuid

access: boolean

Whether the permission is granted or not.

description: string | null

A description for the permission.

name: string

A name for the permission.

maxLength3000

minLength1

created_at?: string | null

Creation datetime

formatdate-time

updated_at?: string | null

Update datetime

formatdate-time

created_at?: string | null

Creation datetime

formatdate-time

updated_at?: string | null

Update datetime

formatdate-time

user_id: string

The user’s ID.

created_at?: string | null

Creation datetime

formatdate-time

project_ids?: Array<string> | null

The project ID scope.

updated_at?: string | null

Update datetime

formatdate-time

created_at?: string | null

Creation datetime

formatdate-time

email?: string | null

The user’s email address.

formatemail

Deprecatedinvited_by_user_email?: string | null

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

formatemail

invited_by_user_id?: string | null

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

pending?: boolean

Whether the user’s membership is pending account signup.

updated_at?: string | null

Update datetime

formatdate-time

user_id?: string | null

The user’s ID.

UserAddResponse = Array<OrganizationMember { id, organization_id, roles, 7 more } >

id: string

Unique identifier

formatuuid

organization_id: string

The organization’s ID.

formatuuid

roles: Array<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<Permission>

The actual permissions of the role.

id: string

Unique identifier

formatuuid

access: boolean

Whether the permission is granted or not.

description: string | null

A description for the permission.

name: string

A name for the permission.

maxLength3000

minLength1

created_at?: string | null

Creation datetime

formatdate-time

updated_at?: string | null

Update datetime

formatdate-time

created_at?: string | null

Creation datetime

formatdate-time

updated_at?: string | null

Update datetime

formatdate-time

user_id: string

The user’s ID.

created_at?: string | null

Creation datetime

formatdate-time

project_ids?: Array<string> | null

The project ID scope.

updated_at?: string | null

Update datetime

formatdate-time

created_at?: string | null

Creation datetime

formatdate-time

email?: string | null

The user’s email address.

formatemail

Deprecatedinvited_by_user_email?: string | null

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

formatemail

invited_by_user_id?: string | null

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

pending?: boolean

Whether the user’s membership is pending account signup.

updated_at?: string | null

Update datetime

formatdate-time

user_id?: string | null

The user’s ID.

UserListProjectsResponse = Array<UserListProjectsResponseItem>

id: string

Unique identifier

formatuuid

name: string

organization_id: string

The Organization ID the project is under.

formatuuid

created_at?: string | null

Creation datetime

formatdate-time

is_default?: boolean

Whether this project is the default project for the user.

updated_at?: string | null

Update datetime

formatdate-time

UserAddToProjectResponse = unknown

UserRemoveFromProjectResponse = unknown