API Reference

User

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Organizations

List Organizations

Deprecated

client.user.organizations.list(OrganizationListParams { direction, match, name, 4 more } query?, RequestOptionsoptions?): V4PagePaginationArray<Organization { id, name, permissions, 2 more } >

GET/user/organizations

Organization Details

Deprecated

client.user.organizations.get(stringorganizationId, RequestOptionsoptions?): OrganizationGetResponse

GET/user/organizations/{organization_id}

Leave Organization

Deprecated

client.user.organizations.delete(stringorganizationId, RequestOptionsoptions?): OrganizationDeleteResponse { id }

DELETE/user/organizations/{organization_id}

ModelsExpand Collapse

Organization { id, name, permissions, 2 more }

id?: string

Identifier

maxLength32

minLength32

name?: string

Organization name.

maxLength100

permissions?: Array<Permission>

Access permissions for this User.

roles?: Array<string>

List of roles that a user has within an organization.

status?: Status

Whether the user is a member of the organization or has an invitation pending.

OrganizationGetResponse = unknown

OrganizationDeleteResponse { id }

id?: string

Identifier

maxLength32

minLength32