v1

latestOpenAPI 3.1.0MIT2026-07-243952451019.0 KB
User

List Users

List users for the current account. Note: an OAuth/API integration authenticates as a platform-agent user (e.g. "Default API Client"), so this endpoint is scoped to that agent and typically returns only it — it is not the way to enumerate the human team members. To find real team members (for example a workflow notify_step's user_ids), use GET /api/v2/teams/{team_id}/memberships and read each membership's user_id (notify_step only accepts non-platform team members).

get/users

Query parameters

afterstring

ID of item after which the collection should be returned. More examples and info about pagination in our guides.

sort_order'asc' | 'desc'

Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples in our guides.

sort_property'id' | 'updated_at'

Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

Response

OK

idinteger

User ID

public_idstring nullable

User public ID

emailstring

Email Address

first_namestring

First Name

last_namestring

Last Name

time_zonestring nullable

Your Time Zone

localestring nullable

Language

created_atstring date-time nullable

Signed up

updated_atstring date-time nullable

Updated

Example response

[
  {
    "id": 1,
    "public_id": "prbtEx",
    "email": "test@email.com",
    "first_name": "Lili",
    "last_name": "Stiedemann",
    "time_zone": "Pacific Time (US & Canada)",
    "locale": "en",
    "created_at": "2025-01-01T00:00:00.000Z",
    "updated_at": "2025-01-01T00:00:00.000Z"
  }
]