Sign in

v2

latestOpenAPI 3.0.02026-07-26365590.3 KB
Users

List organization users

Returns a paginated list of users (organization members) who have access to at least one of the workspaces accessible by the API key. Use the organizationMembershipId to create sequences. Use the workspaceIds query parameter to narrow results to a subset of those workspaces.

get/v1/users

Query parameters

workspaceIdsstring
Example:550e8400-e29b-41d4-a716-446655440000,6ba7b810-9dad-11d1-80b4-00c04fd430c8

Workspace IDs to narrow down results. Must be a subset of the workspaces accessible by the API key. Omit to return data from every workspace in scope. Accepts either a comma-separated string (?workspaceIds=uuid1,uuid2) — the documented format — or repeated array params (?workspaceIds[]=uuid1&workspaceIds[]=uuid2).

pagenumber
Example:1

Page number (1-indexed)

limitnumber
Example:50

Number of items per page

Response

Paginated list of users

totalnumber required
pagenumber required
limitnumber required
totalPagesnumber required

Example response

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "organizationMembershipId": "987e6543-e21b-45d3-b678-426614174001",
      "email": "john.doe@example.com",
      "role": "MEMBER",
      "status": "ACTIVE"
    }
  ],
  "total": 100,
  "page": 1,
  "limit": 10,
  "totalPages": 10
}