Get paginated users list | Atomicwork

curl -G https://{tenant}.atomicwork.com/api/v1/users/list \
     -H "X-Workspace-Id: 987654321" \
     -H "X-Api-Key: <apiKey>" \
     -H "Content-Type: application/json" \
     -d page=1 \
     -d sort_order=CREATED_AT_DESC \
     -d user_status=ACTIVE \
     -d invitation_status=ADDED \
     -d search_key=john.doe \
     -d per_page=25 \
     -d is_deleted=false \
     -d has_slack=true \
     --data-urlencode "role=Support Agent" \
     -d role_id=42 \
     -d types=EMPLOYEE \
     -d types=EXTERNAL \
     -d expand=WORKSPACES \
     -d excluded_user_ids=1001 \
     -d excluded_user_ids=1002 \
     -d notification_enabled=true \
     -d employee_id=EMP12345

{
  "users": [
    {
      "id": 101,
      "name": "John Doe",
      "email": "john.doe@example.com",
      "role": "Support Agent",
      "status": "ACTIVE",
      "invitation_status": "ADDED",
      "type": "EMPLOYEE",
      "has_slack": true,
      "notification_enabled": true,
      "employee_id": "EMP12345",
      "workspaces": [
        {
          "id": 987654321,
          "name": "Acme Corp Workspace"
        }
      ],
      "created_at": "2024-04-10T09:15:00Z",
      "updated_at": "2024-05-01T12:00:00Z"
    },
    {
      "id": 102,
      "name": "Jane Smith",
      "email": "jane.smith@example.com",
      "role": "Support Agent",
      "status": "ACTIVE",
      "invitation_status": "EMAIL_INVITE_SENT",
      "type": "EXTERNAL",
      "has_slack": false,
      "notification_enabled": false,
      "employee_id": "EMP12346",
      "workspaces": [
        {
          "id": 987654321,
          "name": "Acme Corp Workspace"
        }
      ],
      "created_at": "2024-03-20T14:45:00Z",
      "updated_at": "2024-04-25T08:30:00Z"
    }
  ],
  "page": 1,
  "per_page": 25,
  "total": 2,
  "next_page_token": null
}

Authentication

X-Api-Keystring

API Key authentication via header

Query parameters

search_keystringOptional>=1 character

pageintegerRequired1-100Defaults to 1

per_pageintegerOptional1-100Defaults to 25

sort_orderenumOptional

is_deletedbooleanOptionalDefaults to false

has_slackbooleanOptional

rolestringOptional

role_idlongOptional

user_statusenumOptional

Allowed values:

invitation_statusenumOptional

Allowed values:

typeslist of enumsOptional

Optional comma-separated list of user types to filter by

Allowed values:

expandlist of enumsOptional

Allowed values:

excluded_user_idslist of longsOptional

notification_enabledbooleanOptional

Filter users by notification enabled status

employee_idstringOptional>=1 character

Filter users by employee ID (exact match)

Response

Successful response

Authentication

Headers

Query parameters

Response