Get a list of all customers

You may need to get the list of all customers on your platform. UseGET {URI}/customersendpoint for this purpose:

Endpoint	Purpose
`GET {URI}/customers`	Get a list of all customers on this platform.

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

Query params	Data type	Description
displayName	string	Specify the customer display name to be queried.
status	string	The group or customer status: -ACTIVE -INACTIVE
customerMinDateCreatedAt	date-time	Specify the customer earliest createdAt date to be queried according to RFC 3339, such as "2025-01-01" or "2025-01-01T00:00:00Z". See https://www.ietf.org/rfc/rfc3339.txt
customerMaxDateCreatedAt	date-time	Specify the customer latest createdAt date to be queried according to RFC 3339, such as "2025-01-01" or "2025-01-01T00:00:00Z". See https://www.ietf.org/rfc/rfc3339.txt
accountStatus	string	Specify the account status to be queried. See Account status for more information. - ACTIVE -INACTIVE -DISABLED -FROZEN -DELETED
accountIdentifier	string	Specify the account identifier to be queried.
accountNumber	string	Specify the account number to be queried.
accountDisplayName	string	Specify the account display name to be queried.
accountMinDateCreatedAt	date-time	Specify the earliest createdAt date to be queried according to RFC 3339, such as "2025-01-01" or "2025-01-01T00:00:00Z". See https://www.ietf.org/rfc/rfc3339.txt
accountMaxDateCreatedAt	date-time	Specify the latest createdAt date to be queried according to RFC 3339, such as "2025-01-01" or "2025-01-01T00:00:00Z". See https://www.ietf.org/rfc/rfc3339.txt
paginate	boolean	Paginated payload helps managing the payload and prevents API timeout. Select to paginate the results: -true: paginate the results. -false: not to paginate the results. False is the default.
prevCursor	string	The cursor to use for the previous page of results. This will be ignored if paginate is false.
nextCursor	string	The cursor to use for the next page of results. This will be ignored if paginate is false.
maxResults	int32	The maximum number of results to return. The default is 10, and the maximum is 200. This will be ignored if paginate is false.

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:

200 OK
400 Bad Request
401 Unauthorized
403 Forbidden
422 Unprocessable Entity
500 Internal Server Error
503 Service Unavailable