Skip to main content
GET
/
cardholders
List Cardholders
curl --request GET \
  --url https://api.fyatu.com/api/v3.20/cardholders \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "data": {
    "cardholders": [
      "<unknown>"
    ],
    "pagination": {
      "page": 123,
      "limit": 123,
      "total": 123,
      "pages": 123
    }
  },
  "meta": {
    "requestId": "req_9f3e2a1b4c5d67e8",
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.fyatu.com/llms.txt

Use this file to discover all available pages before exploring further.

Overview

Returns a paginated list of cardholders associated with your business.

Query Parameters

ParameterTypeDescription
pageintegerPage number (default: 1)
limitintegerResults per page (default: 20, max: 100)
statusstringFilter by status: ACTIVE, SUSPENDED, DELETED
kycStatusstringFilter by KYC: UNSUBMITTED, PENDING, APPROVED, REJECTED
searchstringSearch by name, email, or externalId

Response Fields

FieldTypeDescription
idstringCardholder ID
externalIdstringYour internal user identifier
firstNamestringFirst name
lastNamestringLast name
emailstringEmail address
statusstringACTIVE, SUSPENDED, or DELETED
kycStatusstringUNSUBMITTED, PENDING, APPROVED, or REJECTED
cardCountintegerNumber of active cards
createdAtstringCreation timestamp

Authorizations

Authorization
string
header
required

JWT access token obtained from POST /auth/token

Query Parameters

page
integer
default:1
limit
integer
default:20
Required range: x <= 100
status
enum<string>
Available options:
ACTIVE,
SUSPENDED,
DEACTIVATED
kycStatus
enum<string>
Available options:
UNSUBMITTED,
PENDING,
SUBMITTED,
ACCEPTED,
REJECTED

Search by name, email, or externalId

Response

Cardholders retrieved

success
boolean
data
object
meta
object