Users

Get paginated users list in a segment

GET https://{tenant}.atomicwork.com/api/v1/users/{segment_id}/list

Authorization

X-Api-Keyheaderstringrequired

API key authentication.

Headers

X-Workspace-Idheaderstring

Path Parameters

segment_idpathintegerrequired

Query Parameters

search_keyquerystring
pagequeryintegerrequired

Page number. The maximum bounds deep-offset scans only; it is deliberately high because maximum * per_page is the total number of reachable users, and a low cap silently hides users in large tenants. Result-set size is bounded by per_page, not by this.

per_pagequeryinteger
sort_orderqueryenum (string)
Allowed valuesCREATED_AT_DESCCREATED_AT_ASCUPDATED_AT_DESCUPDATED_AT_ASCNAME_EMAIL_ASCNAME_EMAIL_DESC
is_deletedqueryboolean

Filter by deactivation state. true returns only deactivated users, false returns only active users. When omitted, active users are returned by default unless include_deactivated is set. Do not add a schema default here: a materialised default makes the param non-null and renders include_deactivated unreachable in the controller.

rolequerystring
typequeryenum (string)

Automation entity type (see allowed values in the enum schema).

Allowed valuesEMPLOYEEEXTERNALAI_EMPLOYEE
include_deactivatedqueryboolean

Response

200

Successful response