---
title: "Get paginated users list"
method: GET
path: "/api/v1/users/list"
tags: ["users"]
---

# Get paginated users list

`GET /api/v1/users/list`

## Query parameters

- `search_key` string
- `page` integer, required
- `per_page` integer
- `sort_order` 'CREATED_AT_DESC' | 'CREATED_AT_ASC' | 'UPDATED_AT_DESC' | 'UPDATED_AT_ASC' | 'NAME_EMAIL_ASC' | 'NAME_EMAIL_DESC'
- `is_deleted` boolean
- `has_slack` boolean
- `role` string
- `role_id` integer
- `user_status` 'ACTIVE' | 'INACTIVE' | 'ALL'
- `invitation_status` 'ADDED' | 'EMAIL_INVITE_SENT' | 'ACCEPTED'
- `types` ApiV1UsersListGetParametersTypesSchemaItems[]
- `expand` ApiV1UsersListGetParametersExpandSchemaItems[]
- `excluded_user_ids` integer[]
- `notification_enabled` boolean
- `employee_id` string

## Headers

- `X-Api-Key` string, required
- `X-Workspace-Id` string

## Response `200`

Successful response

- UsersGetapiV1UsersListResponse200 — Empty response body

## Changes

- **2026-08-22** `6223f7496274` — 2 breaking, 4 warning
  - for the `query` request parameter `employee_id`, the minLength was increased from `0` to `1`
  - for the `query` request parameter `search_key`, the minLength was increased from `0` to `1`
  - for the `query` request parameter `page`, the max was set to `100.00`
  - for the `query` request parameter `per_page`, the max was set to `100.00`
  - …2 more
- **2026-08-12** `2ab1cf36239b` — 1 info
  - api operation id `getapi-v-1-users-list` removed and replaced with `getapi_v1_users_list`

[Change history](https://skmtc.dev/atomicwork/apis/atomicwork-public-api/changes/api/v1/users/list/get.md)

---

[API](https://skmtc.dev/atomicwork/apis/atomicwork-public-api.md) · [All operations](https://skmtc.dev/atomicwork/apis/atomicwork-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/atomicwork/atomicwork-public-api/revisions/6223f7496274/schema)