Get a list of all customers

The GET {URI}/customers endpoint allows you to retrieve a complete list of all customers associated with your platform or master account in the Tango platform. This is especially useful for platforms that manage multiple clients, departments, or business units under a single integration.

Use case

Acme is a corporate wellness provider that uses Tango API to distribute digital rewards to employees and clients as part of health challenges, incentive programs, and engagement campaigns. Acme may have multiple sub-clients or departments such as HR, Marketing, etc. each set up as a separate customer in the Tango system.

Use the following endpoint to list all customer profiles under their master account:

Use the query parameters to filter the payload and improve the results. The following query parameters can be used with this endpoint:

The following payload is an example for when you use GET {URI}/customers\:

 [
  {
    "customerIdentifier": "string", (5-100 chars)
    "displayName": "string",(100 chars)
    "status": "string",
    "createdAt": "2024-03-11T19:30:55.706Z",
    "accounts": [
      {
        "accountIdentifier": "string", (5-100 chars)
        "accountNumber": "string",
        "displayName": "string", (100 chars)
        "createdAt": "2024-03-11T19:30:55.706Z",
        "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: