API Reference

Organizations

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Roles

List Roles

client.organizations.roles.list(stringorganizationID, RequestOptionsoptions?): RoleListResponse { id, name, permissions, 2 more }

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

ModelsExpand Collapse

RoleListResponse = Array<Role { id, name, permissions, 2 more } >

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