List cardholders | The Penny Inc

{
  "items": [
    {
      "active": true,
      "address": {
        "city": "New York",
        "country": "US",
        "line_1": "123 Main Street",
        "line_2": "Suite 200",
        "state_or_province": "NY",
        "zip_code": "10001"
      },
      "business_entity_id": "business_entity_01937c9d-3a1e-72b0-8881-3a1e2b088159",
      "business_id": "business_01937b95-484e-75af-8c68-484e5afc68d3",
      "cardholder_id": "cardholder_01937e19-4ebb-75bd-8250-4ebb5bd25085",
      "email": "jordan.rivera@acme.example",
      "family_name": "Rivera",
      "given_name": "Jordan",
      "phone": "+15551234567",
      "program_id": "program_019377de-7f88-7f02-894f-7f88f0294fcb",
      "spend_control_id": "spend_control_019379d9-a170-796b-867a-a17096b67a21",
      "status": "active",
      "type": "individual",
      "version": 1,
      "version_time": "2024-01-15T10:30:00Z"
    }
  ],
  "count": 1,
  "next_page_token": "string"
}

List cardholders belonging to the caller’s business.

Required permissions: cardholder:list.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

business_entity_idstring or nullOptional

Filter by business entity ID. Only needed if your business has multiple business entities.

program_idstring or nullOptional

Filter by program ID. Only needed if your business has multiple programs.

cardholder_typeenum or nullOptional

Filter by cardholder type.

Allowed values:

activeboolean or nullOptional

Filter by active state.

statusenum or nullOptional

Filter by cardholder status.

Allowed values:

page_sizeintegerOptional1-3000Defaults to 100

Maximum number of results to return per page. Defaults to 100.

next_page_tokenstring or nullOptional

Pagination key used to retrieve the next page of results.

Response

The matching cardholders.

itemslist of objects

The list of items returned by the API.

countinteger

The total number of items returned in this response.

next_page_tokenstring or nullOptional

A token for retrieving the next page of results, if applicable.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

422

Unprocessable Entity Error

429

Too Many Requests Error

500

Internal Server Error