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.

ReturnsExpand Collapse

UserListResponse { data }

List of users.

data: Array<User { id, external_id, role } >

id: string

FRAGMENT generated unique ID.

external_id: string

User-provided unique ID.

role: string

Name of the user's role.

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",
      "external_id": "user_ext_123",
      "role": "admin"
    }
  ]
}

Returns Examples

200 example

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