API Reference

Roles

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

List

client.roles.list(RequestOptionsoptions?): RoleListResponse { data }

GET/roles

Lists all roles for the workspace

ReturnsExpand Collapse

RoleListResponse { data }

List of roles

data: Array<Data>

id: string

Unique role ID

role: string

Name of the role

List

TypeScript

HTTP

TypeScript

Python

import Fragment from '@fragment-dev/ts-node';

const client = new Fragment();

const roles = await client.roles.list();

console.log(roles.data);

200 example

{
  "data": [
    {
      "id": "role_abc123",
      "role": "admin"
    }
  ]
}

Returns Examples

200 example

{
  "data": [
    {
      "id": "role_abc123",
      "role": "admin"
    }
  ]
}