Create workspace user

Creates a user and adds them to the workspace. This endpoint can be called by a session member or a workspace-scoped API key with write access.

POST/api/v1/workspaces/{workspaceHandle}/users

Creates a user and adds them to the workspace. This endpoint can be called by a session member or a workspace-scoped API key with write access.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*nonEmptyString

a non empty string

Length1 <= length

email*nonEmptyString

a non empty string

Length1 <= length

password*nonEmptyString

a non empty string

Length1 <= length

Response Body

`application/json`

curl -X POST "https://loading/api/v1/workspaces/{workspaceHandle}/users" \  -H "Content-Type: application/json" \  -d '{    "name": "Agent Operator",    "email": "agent-operator@example.com",    "password": "supersecret123"  }'

{
  "workspace": {
    "handle": "acme-growth-team",
    "name": "Acme Growth Team",
    "createdAt": "2026-03-05T18:00:00.000Z",
    "updatedAt": "2026-03-05T18:00:00.000Z",
    "deletedAt": null
  },
  "user": {
    "id": "user_01HXYZ1234567890ABCDEFG",
    "name": "Agent Operator",
    "email": "agent-operator@example.com",
    "emailVerified": false,
    "createdAt": "2026-03-05T20:00:00.000Z",
    "updatedAt": "2026-03-05T20:00:00.000Z"
  }
}

{
  "issues": [
    {
      "_tag": "Pointer",
      "path": [
        "string"
      ],
      "message": "string"
    }
  ],
  "message": "string",
  "_tag": "HttpApiDecodeError"
}

{
  "code": "authentication_required",
  "message": "Authentication required. Send Authorization: Bearer <api-key>, x-api-key, or a signed-in session."
}

{
  "code": "insufficient_permissions",
  "message": "This API key does not have workspaces.write permission.",
  "details": {
    "requiredPermission": "workspaces.write"
  }
}

{
  "code": "not_found",
  "message": "The requested resource was not found."
}

{
  "code": "conflict",
  "message": "The requested resource already exists."
}

{
  "code": "internal_error",
  "message": "An unexpected server error occurred."
}

Create workspace user

Request Body

Response Body

201application/json

400application/json

401application/json

403application/json

404application/json

409application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`