Skip to main content
GET
/
v1
/
users
List
curl --request GET \
  --url https://api.cadanapay.com/v1/users \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "firstName": "John",
      "lastName": "Doe",
      "email": "<string>",
      "phoneNumber": {
        "countryCode": "1",
        "number": "2345678901"
      },
      "metadata": {
        "customField1": "value1",
        "customField2": "value2"
      },
      "id": "8ef9a712-cdae-4110-b1ea-9ba95abbee6e",
      "personId": "8ef9a712-cdae-4110-b1ea-9ba95abbee6e",
      "roleId": "8ef9a712-cdae-4110-b1ea-9ba95abbee6e",
      "status": "active"
    }
  ],
  "meta": {
    "limit": 1,
    "currentPage": 1,
    "skipped": 1,
    "pages": 1,
    "itemCount": 1
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-MultiTenantKey
string

Required when using a Platform API token. The tenant key identifying which business to operate on.

Query Parameters

page
integer

Page number to retrieve

Required range: x >= 1
limit
integer

Maximum number of items to return per page

Required range: 1 <= x <= 100
personId
string

Filter by person ID

email
string

Filter by email

includeStatus
string

Toggle including user status in the response

Response

get users response

data
object[]
meta
object

Meta about the pagination