v2
latestOpenAPI 3.0.02026-07-31172752.6 KBusers
List users
Returns a paginated list of users in your organization.
get/api/v1/users
Query parameters
limitinteger
Maximum results to return (default: 20, max: 100)
cursorstring
Opaque cursor returned in the previous response's meta.next_cursor. Omit for the first page.
status'onboarding_provisioning_planned' | 'onboarding' | 'active' | 'inactive' | 'offboarding_planned' | 'offboarding' | 'offboarded' | 'all'
Filter users by status. Returns active users by default
Response
User list
Example response
{
"data": [
{
"deactivated_at": null,
"departments": [
"Engineering"
],
"email": "john@example.com",
"employment_type": "full_time",
"first_name": "John",
"full_name": "John Doe",
"id": "7488a646-e31f-11e4-aace-600308960662",
"inserted_at": "2023-01-01T00:00:00Z",
"job_title": "Software Engineer",
"last_name": "Doe",
"location_city": "San Francisco",
"manager_user_id": null,
"status": "active",
"teams": [
"Engineering",
"Backend"
],
"updated_at": "2023-01-01T00:00:00Z"
}
],
"meta": {
"page": 1,
"page_size": 20,
"total_count": 100,
"total_pages": 5
}
}