Get paginated users list in a segment | Atomicwork

Authentication

X-Api-Keystring

API Key authentication via header

Path parameters

segment_idlongRequired

Query parameters

search_keystringOptional>=1 character

pageintegerRequired1-100Defaults to 1

per_pageintegerOptional1-100Defaults to 25

sort_orderenumOptional

is_deletedbooleanOptional

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.

rolestringOptional

typeenumOptional

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

Allowed values:

include_deactivatedbooleanOptionalDefaults to false

Response

Successful response

$	curl -G https://{tenant}.atomicwork.com/api/v1/users/1/list \
>	-H "X-Workspace-Id: 42" \
>	-H "X-Api-Key: <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d page=1 \
>	-d sort_order=CREATED_AT_DESC \
>	-d type=EMPLOYEE \
>	-d search_key=john.doe \
>	-d per_page=25 \
>	-d is_deleted=false \
>	-d role=support_agent \
>	-d include_deactivated=false

Authentication

Path parameters

Headers

Query parameters

Response