VEvelopaymentsapi
Users

List Users

Changed on

Get a paginated response listing the Users

get/v2/users

Request

  • Base URL
    https://api.sandbox.velopayments.com
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://api.sandbox.velopayments.com/v1/login

Query parameters

type'BACKOFFICE' | 'PAYOR' | 'PAYEE'
Example:PAYOR

The Type 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

Example:ENABLED

The status of the User.

entityIdstring uuid

The entityId of the User.

payeeType'COMPANY' | 'INDIVIDUAL'
Example:COMPANY

The Type of the Payee entity. Either COMPANY or INDIVIDUAL.

pageinteger

Page number. Default is 1.

pageSizeinteger

The number of results to return in a page

sortstring

List of sort fields (e.g. ?sort=email:asc,lastName:asc) Default is email:asc 'name' The supported sort fields are - email, lastNmae.

Response

Paginated list of Users filtered by query parameters

Example response

{
  "links": [
    {
      "rel": "first",
      "href": "https://api.sandbox.velopayments.com/v2/users??type=PAYOR&page=1&pageSize=10"
    },
    {
      "rel": "first",
      "href": "https://api.sandbox.velopayments.com/v2/users??type=PAYOR&page=1&pageSize=10"
    }
  ],
  "page": {
    "numberOfElements": 12,
    "totalPages": 2,
    "pageSize": 25,
    "page": 1,
    "totalElements": 33
  },
  "content": [
    {
      "lastName": "Doe",
      "companyName": "Acme Corp",
      "roles": [
        "payor.admin"
      ],
      "lockedOutTimestamp": "2000-01-23T04:56:07.000+00:00",
      "smsNumber": "11235555555",
      "entityId": "7fffa261-ac68-49e6-b605-d24a444d9206",
      "mfaStatus": "REGISTERED",
      "firstName": "John",
      "primaryContactNumber": "11235555555",
      "mfaType": "TOTP",
      "lockedOut": true,
      "id": "8bbf301c-948f-4445-b411-357eec53e441",
      "userType": "PAYOR",
      "email": "foo@example.com",
      "secondaryContactNumber": "11235555550",
      "status": "ENABLED"
    },
    {
      "lastName": "Doe",
      "companyName": "Acme Corp",
      "roles": [
        "payor.admin"
      ],
      "lockedOutTimestamp": "2000-01-23T04:56:07.000+00:00",
      "smsNumber": "11235555555",
      "entityId": "7fffa261-ac68-49e6-b605-d24a444d9206",
      "mfaStatus": "REGISTERED",
      "firstName": "John",
      "primaryContactNumber": "11235555555",
      "mfaType": "TOTP",
      "lockedOut": true,
      "id": "8bbf301c-948f-4445-b411-357eec53e441",
      "userType": "PAYOR",
      "email": "foo@example.com",
      "secondaryContactNumber": "11235555550",
      "status": "ENABLED"
    }
  ]
}

Changes

  • 05c3f09fc50aRevision changes
    • warning

      added the new VERIFIED enum value to the // response property for the response status

  • 12abf05c40faRevision changes
    • info

      added the new optional query request parameter payeeType

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status