Skip to main content
GET
/
cardholders
List Cardholders
curl --request GET \
  --url https://api.fyatu.com/api/v2/cardholders \
  --header 'Authorization: Bearer <token>' \
  --header 'Business-ID: <api-key>'
{
  "status": "success",
  "statusCode": 200,
  "errors": false,
  "message": "<string>",
  "data": {
    "list": [
      {
        "cardholderId": "<string>",
        "firstName": "<string>",
        "lastName": "<string>",
        "email": "[email protected]",
        "phone": "<string>",
        "dateOfBirth": "2023-12-25",
        "gender": "MALE",
        "address": "<string>",
        "city": "<string>",
        "state": "<string>",
        "country": "<string>",
        "status": "ACTIVE"
      }
    ],
    "pagination": {
      "totalItems": 123,
      "totalPages": 123,
      "currentPage": 123,
      "itemsPerPage": 123
    }
  }
}

Authorizations

Business-ID
string
header
required

Your unique business identifier. Find this in your Business Settings.

Authorization
string
header
required

Your API key as a Bearer token. Example: Bearer sk_live_xxxxxxxxxxxxx

Query Parameters

page
integer
default:1

Page number

limit
integer
default:50

Items per page (max 100)

Required range: x <= 100

Response

Cardholders list retrieved

status
string
Example:

"success"

statusCode
integer
Example:

200

errors
boolean
Example:

false

message
string
data
object