Skip to main content
GET
/
partner
/
cardholders
List cardholders
curl --request GET \
  --url https://api.contro.me/v1/partner/cardholders \
  --header 'x-contro-api-key: <api-key>'
{
  "data": [
    {
      "id": "ch_abc123",
      "externalUserId": "user_42",
      "firstName": "Jane",
      "lastName": "Doe",
      "email": "jane@example.com",
      "phoneNumber": "+14155552671",
      "kycSource": "api",
      "kycStatus": "approved",
      "status": "active",
      "createdAt": "2026-03-20T14:30:00Z"
    }
  ],
  "total": 123,
  "page": 123,
  "limit": 123
}

Authorizations

​
x-contro-api-key
string
header
required

Partner API key (sk_live_* for production, sk_test_* for sandbox)

Query Parameters

​
page
integer
default:1

Page number

Required range: x >= 1
​
limit
integer
default:20

Number of items per page (1-100)

Required range: 1 <= x <= 100
​
from
string<date-time>

ISO 8601 start timestamp (inclusive)

​
to
string<date-time>

ISO 8601 end timestamp (inclusive)

​
status
string

Filter by cardholder status. One of: active, suspended, closed

Example:

"active"

​
kycStatus
string

Filter by KYC status. One of: pending, approved, rejected

Example:

"approved"

​
externalUserId
string

Filter by partner-supplied external user ID

Example:

"user_123"

Response

List of cardholders

​
data
object[]
required
​
total
number
required
​
page
number
required
​
limit
number
required