Skip to main content
GET
/
business
/
cardholders
List cardholders
curl --request GET \
  --url https://api-staging.usenumero.com/numeroaccount/api/v1/business/cardholders \
  --header 'X-Numero-Api-Key: <api-key>'
{
  "data": [
    {
      "customerId": "NCUS9953596C2B7F45",
      "firstName": "<string>",
      "lastName": "<string>",
      "email": "<string>",
      "phone": "<string>",
      "country": "<string>",
      "status": "<string>",
      "activeCardCount": 123,
      "createdAt": "2023-11-07T05:31:56Z"
    }
  ],
  "error": {
    "message": "<string>",
    "param": "<string>"
  },
  "meta": {
    "request_id": "<string>",
    "pagination": {
      "page": 123,
      "page_size": 123,
      "total": 123,
      "has_more": true
    }
  }
}

Authorizations

​
X-Numero-Api-Key
string
header
required

Your business API key (live_key_...). Issued on approval; managed in Dashboard → Settings → Developer.

Query Parameters

​
pageNumber
integer
default:1
Required range: x >= 1
​
pageSize
integer
default:50
Required range: 1 <= x <= 200

Response

Cardholders

Canonical response envelope for the public surface. data on success, error on failure.

​
data
object[]
required

Endpoint payload on success (object or array); null on failure.

​
error
object
required
​
meta
object
required