---
title: "Get users list"
method: GET
path: "/users"
tags: ["Users"]
---

# Get users list

`GET /users`

Returns a paginated list of users

## Query parameters

- `cursor` string, uuid
- `limit` integer

## Response `200`

successful operation

- UserPaginationResponseJson
  - `data` UserJson[]
    - `id` string
    - `displayName` string
    - `title` string
    - `email` string
    - `phoneNumber` string
    - `state` 'ACTIVE' | 'DISABLED' | 'EXPIRED'
    - `role` 'ADMIN' | 'FINANCE' | 'SALES' | 'SALES_MANAGER' | 'ACCOUNTANT' | 'BILLING_CLERK' | 'REVENUE_CLERK' | 'READ_ONLY' | 'EXECUTIVE' | 'CRM' | 'IMPORT' | 'BILLY_ADMIN' | 'BILLY_ENGINEER' | 'BILLY_SUPPORT' | 'BILLY_JOB'
    - `ssoOnly` boolean
    - `tenantName` string
    - `cognitoUserStatus` 'UNCONFIRMED' | 'CONFIRMED' | 'ARCHIVED' | 'COMPROMISED' | 'UNKNOWN' | 'RESET_REQUIRED' | 'FORCE_CHANGE_PASSWORD' | 'EXTERNAL_PROVIDER' | 'UNKNOWN_TO_SDK_VERSION'
    - `userGroups` UserGroupJson[]
      - `id` string
      - `entityIds` string[]
      - `name` string
      - `description` string
      - `users` string[]
      - `externalId` string
    - `approvalSegments` ApprovalSegmentJson[]
      - `id` string
      - `name` string
      - `description` string
      - `createdOn` integer
      - `updatedOn` integer
    - `hasAllEntitiesAccess` boolean
    - `availableEntities` EntityRef[]
      - `entityId` string, required
      - `displayId` string
      - `name` string, required
    - `entityIds` string[]
    - `externalId` string
    - `eventObjectId` string
  - `numElements` integer
  - `nextCursor` string, uuid

---

[API](https://skmtc.net/dealhub/apis/quote-api.md) · [All operations](https://skmtc.net/dealhub/apis/quote-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/dealhub/quote-api/versions/c30f5b9fbfab/schema)