Get paginated users list

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

Authorization

X-Api-Keyheaderstringrequired

Headers

X-Workspace-Idheaderstring

Query Parameters

search_keyquerystring

pagequeryintegerrequired

per_pagequeryinteger

sort_orderqueryenum (string)

is_deletedqueryboolean

has_slackqueryboolean

rolequerystring

role_idqueryinteger

user_statusqueryenum (string)

invitation_statusqueryenum (string)

typesqueryarray of enum (string)

Optional comma-separated list of user types to filter by

expandqueryarray of enum (string)

excluded_user_idsqueryarray of integer

notification_enabledqueryboolean

Filter users by notification enabled status

employee_idquerystring

Filter users by employee ID (exact match)

Response

200application/json

Successful response

Get paginated users list

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

Authorization

X-Api-Keyheaderstringrequired

Headers

X-Workspace-Idheaderstring

Query Parameters

search_keyquerystring

pagequeryintegerrequired

per_pagequeryinteger

sort_orderqueryenum (string)

is_deletedqueryboolean

has_slackqueryboolean

rolequerystring

role_idqueryinteger

user_statusqueryenum (string)

invitation_statusqueryenum (string)

typesqueryarray of enum (string)

Optional comma-separated list of user types to filter by

expandqueryarray of enum (string)

excluded_user_idsqueryarray of integer

notification_enabledqueryboolean

Filter users by notification enabled status

employee_idquerystring

Filter users by employee ID (exact match)

Response

200application/json

Successful response