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
}
}Get all users
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
}
}Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Required when using a Platform API token. The tenant key identifying which business to operate on.
Page number to retrieve
x >= 1Maximum number of items to return per page
1 <= x <= 100Filter by person ID
Filter by email
Toggle including user status in the response