Skip to main content

Users

List and look up workspace members via the external API.

Authentication

All endpoints require an Authorization header with a valid org API key:

Endpoints

List users (paginated)

Returns a paginated list of users in the workspace/org associated with the API key.

Query parameters

  • page (optional, integer, default: 0) — Zero‑based page index.
  • page_size (optional, integer, default: 10, max: 100) — Number of users to return per page.

Response

Get a single user by ID

Fetch a single user by their UUID. The user must belong to the workspace/org associated with the API key.

Response

Get a single user by email

Fetch a single user by their email address (case-insensitive). The user must belong to the workspace/org associated with the API key.

Response

Errors

  • 400 Bad Request if:
    • Neither id nor email is provided.
    • Both id and email are provided.
    • The user ID or email is not found in your workspace.
  • 401 Unauthorized if the API key is missing or invalid.