Get a list of all accounts for a customer

The GET {URI}/customers/{customerIdentifier}/accounts endpoint allows you to retrieve a list of all accounts created under a specific customer on your platform. This is especially useful for platforms that manage multiple reward budgets or programs within a single customer organization.

Use case

Acme Wellness has a customer, Zanzibar Health Group, that uses multiple accounts to manage different reward budgets—such as one for employee wellness and another for client engagement. Acme needs to retrieve a list of all accounts under this customer to check available balances, to set low balance alerts, and to send rewards from the correct account. Each account typically represents a separate budget or use case under that customer.

Use the following endpoint to get a list of all accounts created for a specific customer on your platform:

The following path parameters are used with this endpoint:

The following query parameters are used with this endpoint:

The following payload is an example for this endpoint:

[
  {
    "currentBalance": 0,
    "contactEmail": "string",
    "fundingNotification": [
      {
        "emailAddress": "string"
      }
    ],
    "accountIdentifier": "string",
    "accountNumber": "string",
    "displayName": "string",
    "createdAt": "2024-03-14T16:18:41.061Z",
    "status": "string",
    "currencyCode": "string"
  }
]

Here's an example payload for when you receive an error:

{
  "timestamp": "2025-02-21T23:23:13.930Z",
  "requestId": "string",
  "path": "string",
  "httpCode": 0,
  "httpPhrase": "string",
  "i18nKey": "string",
  "message": "The error message will show here for error codes ",
  "errors": [
    {}
  ]
}

The possible response codes for this endpoint are as follows. For details, see i18nkey codes and their error messages: