API Reference

Users

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

List

client.users.list(RequestOptionsoptions?): UserListResponse { data }

GET/users

Lists all users for the workspace

ReturnsExpand Collapse

UserListResponse { data }

List of users

data: Array<Data>

id: string

Unique user ID

externalId: string

External ID for the user

role: string

Role of the user

List

TypeScript

HTTP

TypeScript

Python

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

const client = new Fragment();

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

console.log(users.data);

200 example

{
  "data": [
    {
      "id": "user_abc123",
      "externalId": "user_ext_123",
      "role": "admin"
    }
  ]
}

Returns Examples

200 example

{
  "data": [
    {
      "id": "user_abc123",
      "externalId": "user_ext_123",
      "role": "admin"
    }
  ]
}