Users
Get paginated users list in a segment
GET https://{tenant}.atomicwork.com/api/v1/users/{segment_id}/list
Authorization
X-Api-KeyrequiredAPI key authentication.
Headers
X-Workspace-IdPath Parameters
segment_idrequiredQuery Parameters
search_keypagerequiredPage 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_pagesort_orderCREATED_AT_DESCCREATED_AT_ASCUPDATED_AT_DESCUPDATED_AT_ASCNAME_EMAIL_ASCNAME_EMAIL_DESCis_deletedFilter 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.
roletypeAutomation entity type (see allowed values in the enum schema).
EMPLOYEEEXTERNALAI_EMPLOYEEinclude_deactivatedResponse
Successful response
