Get customer list
The Get Customer List API enables partners to retrieve customer accounts associated with a specific reseller using a combination of filters such as customer ID, name, status, creation date, and so on.
| Endpoint | Method |
|---|---|
<env root url>/v3/resellers/<reseller_id>/customers | GET |
This API is essential for partners who manage large customer portfolios and require precise, real-time access to customer data for quoting, reporting, and renewal planning.
This API supports:
- Filtering by reseller ID (mandatory), customer ID, company name with wildcard support, status, and created date range.
- Sorting by customer name or creation date.
- Pagination with up to 50 results per request.
Headers
| Parameter | Description |
|---|---|
X-Request-Id | Required. A unique identifier for the call. The value should be reset for every single request. If this is not provided, then a request ID will be automatically generated. Using a duplicate request ID may return an error. |
Accept | Required. Specifies the response type. Must be "application/json" for proper usage. |
Content-Type | Required. Specifies the request type. Must be "application/json" for proper usage. |
Authorization | Required. Authorization token in the form Bearer <token> |
X-Api-Key | Required. The API Key for your integration |
Request
A sample request is as follows:
GET <env>/v3/resellers/1000404757/customers?company-name=Test*&status=1000&limit=50&offset=0&sort-by=companyName
Request parameters:
| Parameter | Required | Data Type | Description |
|---|---|---|---|
status | No | String | Status of the resellers. Default value is 1000. Supported values include 1000, 1002, 1004, and 1026. |
from-created-date | No | Date | Filters customers created from the specified date. Default value is null. |
to-created-date | No | Date | Filters customers created up to the specified date. Default value is null. |
offset | No | Specifies the starting point for retrieving items in a paginated list. It determines how many items to skip before beginning to return results. If not specified, the default value is 0, meaning the response will start from the first item. | |
company-name | No | String | Name of the customer with wildcard support. |
limit | No | Number of results to return per page. Default value is 20. Must be between 1 and 50. | |
sort-by | No | String | Field used for sorting. Only one field is allowed. Supported values are creationDate and companyName. Default value is creationDate. |
order-by | No | String | Direction of sorting. Supported values are asc and desc. Default value is desc. |
Response
Copied to your clipboard{"totalCount": 8,"count": 2,"offset": 0,"limit": 2,"accounts": [{"externalReferenceId": "a19143f0-b5a7-47d3-abf5-bdfd79dc9ef","customerId": "1006500792","resellerId": "1000396138","status": "1000","companyProfile": {"companyName": "Customer Name 1"},"creationDate": "2025-08-27T12:57:22Z","links": {"self": {"uri": "/v3/customers/1006500792","method": "GET","headers": []}}},{"externalReferenceId": "f0d64802-ebfc-48bb-a3de-d00d67a5b6b","customerId": "1006500806","resellerId": "1000396138","status": "1000","companyProfile": {"companyName": "Customer Name 2"},"creationDate": "2025-08-27T12:57:18Z","links": {"self": {"uri": "/v3/customers/1006500792","method": "GET","headers": []}}}]}
Response parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
totalCount | Integer | Yes | Total count of customers matching search filters. |
count | Integer | Yes | Number of customers returned in the current page items. |
offset | Integer | Yes | Starting index of the current page. |
limit | Integer | Yes | Requested page size. Number of customer items limited in the response. |
customers | Array of Customer | Yes | Customer object. |
Customer obect
| Parameter | Type | Required | Description |
|---|---|---|---|
externalReferenceId | String | Yes | External Reference ID of the customer |
customerId | String | Yes | Unique ID of the customer |
resellerId | String | Yes | Unique ID of the reseller |
status | String | Yes | Status of reseller |
companyProfile.companyName | String | Yes | Name of the customer. |
creationDate | String (ISO Date) | Yes | Customer creation timestamp |
links | Object | Yes | Link to get customer details. GET /v3/customers/<customer-id> |
Status codes
| Status Code | Description |
|---|---|
200 | Customer account details are successfully returned. |
400 | Bad request. |
401 | Invalid Authorization token. |
403 | Invalid API Key. |
429 | Too Many Requests. |
500 | Internal Server Error. |