---
title: "List Users"
method: GET
path: "/v2/users"
tags: ["Users"]
---

# List Users

`GET /v2/users`

Get a paginated response listing the Users

## Query parameters

- `type` 'BACKOFFICE' | 'PAYOR' | 'PAYEE'
- `status` 'ENABLED' | 'DISABLED' | 'PENDING' — The status of the user when the user has been invited but not yet enrolled they will have a PENDING status
- `entityId` string, uuid
- `payeeType` 'COMPANY' | 'INDIVIDUAL'
- `page` integer
- `pageSize` integer
- `sort` string

## Response `200`

Paginated list of Users filtered by query parameters

- PagedUserResponse — List Users Response Object
  - `page` PagedUserResponsePage
    - `numberOfElements` integer
    - `totalElements` integer
    - `totalPages` integer
    - `page` integer
    - `pageSize` integer
  - `links` PagedUserResponseLinks[]
    - `rel` string
    - `href` string
  - `content` UserResponse[]
    - `id` string, uuid — The id of the user
    - `status` 'ENABLED' | 'DISABLED' | 'PENDING' — The status of the user when the user has been invited but not yet enrolled they will have a PENDING status
    - `email` string, email — the email address of the user
    - `smsNumber` string — The phone number of a device that the user can receive sms messages on
    - `primaryContactNumber` string — The main contact number for the user
    - `secondaryContactNumber` string — The secondary contact number for the user
    - `firstName` string
    - `lastName` string
    - `entityId` string, uuid — The payorId or payeeId or null if the user is not a payor or payee user
    - `companyName` string — The payor or payee company name or null if the user is not a payor or payee user
    - `roles` Role[] — The role(s) for the user
      - `name` string, required — the name of the role
    - `userType` 'BACKOFFICE' | 'PAYOR' | 'PAYEE' — Indicates the type of user. Could be BACKOFFICE, PAYOR or PAYEE.
    - `mfaType` 'SMS' | 'YUBIKEY' | 'TOTP' — The type of the MFA device
    - `mfaStatus` 'REGISTERED' | 'UNREGISTERED' | 'VERIFIED' — The status of the MFA device
    - `lockedOut` boolean — If true the user is currently locked out and unable to log in
    - `lockedOutTimestamp` string, date-time, nullable — A timestamp showing when the user was locked out If null then the user is not currently locked out

## Other responses

- `400` — Invalid request. See Error message payload for details of failure
- `401` — Invalid access token. May be expired or invalid
- `403` — The authentication does not have permissions to access the resource This usually occurs when there is a valid authentication instance (client or user) but they do not have the required permissions

---

[API](https://skmtc.net/velopaymentsapi/apis/velo-payments-apis.md) · [All operations](https://skmtc.net/velopaymentsapi/apis/velo-payments-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/velopaymentsapi/velo-payments-apis/versions/05c3f09fc50a/schema)