API Reference

Users

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Create

client.users.create(UserCreateParams { externalId, role } body, RequestOptionsoptions?): UserCreateResponse { data }

POST/users

Creates a new user

ParametersExpand Collapse

body: UserCreateParams { externalId, role }

externalId: string

External ID for the user

role: string

Role of the user

ReturnsExpand Collapse

UserCreateResponse { data }

data: Data { id, externalId, role }

User object

id: string

Unique user ID

externalId: string

External ID for the user

role: string

Role of the user

Create

TypeScript

HTTP

TypeScript

Python

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

const client = new Fragment();

const user = await client.users.create({ externalId: 'user_ext_123', role: 'admin' });

console.log(user.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"
  }
}