API Reference

Organizations

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Users

List Organization Users

organizations.users.list_members(strorganization_id) -> UserListMembersResponse

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

Add Users To Organization

organizations.users.add(strorganization_id, UserAddParams**kwargs) -> UserAddResponse

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

Remove Users From Organization

organizations.users.delete(strmember_user_id, UserDeleteParams**kwargs)

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

Assign Role To User In Organization

organizations.users.assign_role(strpath_organization_id, UserAssignRoleParams**kwargs) -> UserOrganizationRole

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

List Projects By User

organizations.users.list_projects(struser_id, UserListProjectsParams**kwargs) -> UserListProjectsResponse

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

Add User To Project

organizations.users.add_to_project(struser_id, UserAddToProjectParams**kwargs) -> object

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

Remove User From Project

organizations.users.remove_from_project(strproject_id, UserRemoveFromProjectParams**kwargs) -> object

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

ModelsExpand Collapse

List[OrganizationMember]

id: str

Unique identifier

formatuuid

organization_id: str

The organization’s ID.

formatuuid

roles: List[UserOrganizationRole]

The roles of the user in the organization.

id: str

Unique identifier

formatuuid

organization_id: str

The organization’s ID.

formatuuid

role: Role

The role.

id: str

Unique identifier

formatuuid

name: str

A name for the role.

maxLength3000

minLength1

permissions: List[Permission]

The actual permissions of the role.

id: str

Unique identifier

formatuuid

access: bool

Whether the permission is granted or not.

description: Optional[str]

A description for the permission.

name: str

A name for the permission.

maxLength3000

minLength1

created_at: Optional[datetime]

Creation datetime

formatdate-time

updated_at: Optional[datetime]

Update datetime

formatdate-time

created_at: Optional[datetime]

Creation datetime

formatdate-time

updated_at: Optional[datetime]

Update datetime

formatdate-time

user_id: str

The user’s ID.

created_at: Optional[datetime]

Creation datetime

formatdate-time

project_ids: Optional[List[str]]

The project ID scope.

updated_at: Optional[datetime]

Update datetime

formatdate-time

created_at: Optional[datetime]

Creation datetime

formatdate-time

email: Optional[str]

The user’s email address.

formatemail

Deprecatedinvited_by_user_email: Optional[str]

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

formatemail

invited_by_user_id: Optional[str]

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

pending: Optional[bool]

Whether the user’s membership is pending account signup.

updated_at: Optional[datetime]

Update datetime

formatdate-time

user_id: Optional[str]

The user’s ID.

List[OrganizationMember]

id: str

Unique identifier

formatuuid

organization_id: str

The organization’s ID.

formatuuid

roles: List[UserOrganizationRole]

The roles of the user in the organization.

id: str

Unique identifier

formatuuid

organization_id: str

The organization’s ID.

formatuuid

role: Role

The role.

id: str

Unique identifier

formatuuid

name: str

A name for the role.

maxLength3000

minLength1

permissions: List[Permission]

The actual permissions of the role.

id: str

Unique identifier

formatuuid

access: bool

Whether the permission is granted or not.

description: Optional[str]

A description for the permission.

name: str

A name for the permission.

maxLength3000

minLength1

created_at: Optional[datetime]

Creation datetime

formatdate-time

updated_at: Optional[datetime]

Update datetime

formatdate-time

created_at: Optional[datetime]

Creation datetime

formatdate-time

updated_at: Optional[datetime]

Update datetime

formatdate-time

user_id: str

The user’s ID.

created_at: Optional[datetime]

Creation datetime

formatdate-time

project_ids: Optional[List[str]]

The project ID scope.

updated_at: Optional[datetime]

Update datetime

formatdate-time

created_at: Optional[datetime]

Creation datetime

formatdate-time

email: Optional[str]

The user’s email address.

formatemail

Deprecatedinvited_by_user_email: Optional[str]

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

formatemail

invited_by_user_id: Optional[str]

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

pending: Optional[bool]

Whether the user’s membership is pending account signup.

updated_at: Optional[datetime]

Update datetime

formatdate-time

user_id: Optional[str]

The user’s ID.

List[UserListProjectsResponseItem]

id: str

Unique identifier

formatuuid

name: str

organization_id: str

The Organization ID the project is under.

formatuuid

created_at: Optional[datetime]

Creation datetime

formatdate-time

is_default: Optional[bool]

Whether this project is the default project for the user.

updated_at: Optional[datetime]

Update datetime

formatdate-time