Users

Get paginated users list

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

Authorization

X-Api-Keyheaderstringrequired

API key authentication.

Headers

X-Workspace-Idheaderstring

Query Parameters

search_keyquerystring
pagequeryintegerrequired
per_pagequeryinteger
sort_orderqueryenum (string)
Allowed valuesCREATED_AT_DESCCREATED_AT_ASCUPDATED_AT_DESCUPDATED_AT_ASCNAME_EMAIL_ASCNAME_EMAIL_DESC
is_deletedqueryboolean
has_slackqueryboolean
rolequerystring
role_idqueryinteger
user_statusqueryenum (string)
Allowed valuesACTIVEINACTIVEALL
invitation_statusqueryenum (string)
Allowed valuesADDEDEMAIL_INVITE_SENTACCEPTED
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

200

Successful response