Skip to content

User API Reference

API reference for user management.

GET /users

List users with pagination.

Query Parameters

  • page - Page number (default: 1)
  • limit - Items per page (default: 20)
  • role - Filter by role
  • workspace_id - Filter by workspace
  • email - Search by email

Response

{
  "items": [...],
  "total": 100,
  "page": 1,
  "limit": 20
}

GET /users/:id

Get user by ID.

Response

{
  "id": "user:abc123",
  "tenant_id": "org_company",
  "identifiers": [...],
  "roles": ["editor"],
  "created_at": "2025-01-01T00:00:00Z"
}

POST /users

Create new user.

Request

{
  "identifier": "[email protected]",
  "password": "SecurePass123!",
  "roles": ["viewer"]
}

PATCH /users/:id

Update user.

Request

{
  "roles": ["editor", "admin"]
}

DELETE /users/:id

Delete user.

Response

{
  "message": "User deleted successfully"
}