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.

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

Request

A sample request is as follows:

GET <env>/v3/resellers/<reseller_id>/customers?status=1000&company-name=INGRAM&offset=3&limit=3&sort-by=creationDate&order-by=desc

Request parameters:

Response

Copy
{
  "totalCount": 9,
  "count": 3,
  "offset": 3,
  "limit": 3,
  "customers": [
    {
      "externalReferenceId": "a60924a0-170d-4d21-8736-3f927037371",
      "customerId": "1006374020",
      "resellerId": "1000361686",
      "status": "1000",
      "companyProfile": {
        "companyName": "Test Customer 222",
        "preferredLanguage": "en-US",
        "marketSegment": "",
        "marketSubSegments": [],
        "address": {
          "country": "US",
          "region": "CA",
          "city": "San Jose",
          "addressLine1": "345 Park Ave",
          "addressLine2": "",
          "postalCode": "95110",
          "phoneNumber": ""
        },
        "contacts": [
          {
            "firstName": "first_name",
            "lastName": "last_name",
            "email": "abc@xyz.com"
          }
        ]
      },
      "discounts": [],
      "tags": [],
      "cotermDate": "",
      "creationDate": "2025-07-29T10:42:31Z",
      "benefits": [],
      "globalSalesEnabled": false
    },
    {}, {}
  ]
}
Copied to your clipboard
{
  "totalCount": 9,
  "count": 3,
  "offset": 3,
  "limit": 3,
  "customers": [
    {
      "externalReferenceId": "a60924a0-170d-4d21-8736-3f927037371",
      "customerId": "1006374020",
      "resellerId": "1000361686",
      "status": "1000",
      "companyProfile": {
        "companyName": "Test Customer 222",
        "preferredLanguage": "en-US",
        "marketSegment": "",
        "marketSubSegments": [],
        "address": {
          "country": "US",
          "region": "CA",
          "city": "San Jose",
          "addressLine1": "345 Park Ave",
          "addressLine2": "",
          "postalCode": "95110",
          "phoneNumber": ""
        },
        "contacts": [
          {
            "firstName": "first_name",
            "lastName": "last_name",
            "email": "abc@xyz.com"
          }
        ]
      },
      "discounts": [],
      "tags": [],
      "cotermDate": "",
      "creationDate": "2025-07-29T10:42:31Z",
      "benefits": [],
      "globalSalesEnabled": false
    },
    {}, {}
  ]
}

Response parameters:

Status codes