getCustomersList

getCustomersList

Path Parameters

serviceSubscriberDepartmentToken string required

Query Parameters

searchTerm string required
searchPreference string
maxResults int32
queryOperator string
fieldsToBeSearched string

Responses

• 200
• 204
• 400
• 401
• 500

---

OK

application/json

Schema

Example (from schema)

---

Schema

errors object[]
Array [
errorCode int32
errorTitle string
errorMessage string
]
warnings object[]
Array [
warningCode int32
warningTitle string
warningMessage string
]
customers object[]
Array [
id int64
customerKey string
firstName string
middleName string
lastName string
company string
preferredLocale string
emails object[]
Array [
emailAddress string
label string
okToEmail boolean
isPreferred boolean
comments string
]
phoneNumbers object[]
Array [
phoneNumber string
label string
okToCall boolean
okToText boolean
isPreferred boolean
comments string
]
preferredCommunication string
bestTimeToContact object
startTime string
endTime string
addresses object[]
Array [
line1 string
line2 string
city string
zip string
addressType string
type string
Possible values: [COMMON, PRIMARY, BILLING, OTHER]
country string
updateTS date-time
uuid string
isValid boolean
isPreferred boolean
state string
]
availability int32
isBusiness boolean
customerUuid string
customerId string
]

{
  "errors": [
    {
      "errorCode": 0,
      "errorTitle": "string",
      "errorMessage": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": 0,
      "warningTitle": "string",
      "warningMessage": "string"
    }
  ],
  "customers": [
    {
      "id": 0,
      "customerKey": "string",
      "firstName": "string",
      "middleName": "string",
      "lastName": "string",
      "company": "string",
      "preferredLocale": "string",
      "emails": [
        {
          "emailAddress": "string",
          "label": "string",
          "okToEmail": true,
          "isPreferred": true,
          "comments": "string"
        }
      ],
      "phoneNumbers": [
        {
          "phoneNumber": "string",
          "label": "string",
          "okToCall": true,
          "okToText": true,
          "isPreferred": true,
          "comments": "string"
        }
      ],
      "preferredCommunication": "string",
      "bestTimeToContact": {
        "startTime": "string",
        "endTime": "string"
      },
      "addresses": [
        {
          "line1": "string",
          "line2": "string",
          "city": "string",
          "zip": "string",
          "addressType": "string",
          "type": "COMMON",
          "country": "string",
          "updateTS": "2025-10-30T17:04:36.803Z",
          "uuid": "string",
          "isValid": true,
          "isPreferred": true,
          "state": "string"
        }
      ],
      "availability": 0,
      "isBusiness": true,
      "customerUuid": "string",
      "customerId": "string"
    }
  ]
}

No Content

*/*

Schema

Example (from schema)

---

Schema

errors object[]
Array [
errorCode int32
errorTitle string
errorMessage string
]
warnings object[]
Array [
warningCode int32
warningTitle string
warningMessage string
]

{
  "errors": [
    {
      "errorCode": 0,
      "errorTitle": "string",
      "errorMessage": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": 0,
      "warningTitle": "string",
      "warningMessage": "string"
    }
  ]
}

Bad Request

*/*

Schema

Example (from schema)

---

Schema

errors object[]
Array [
errorCode int32
errorTitle string
errorMessage string
]
warnings object[]
Array [
warningCode int32
warningTitle string
warningMessage string
]

{
  "errors": [
    {
      "errorCode": 0,
      "errorTitle": "string",
      "errorMessage": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": 0,
      "warningTitle": "string",
      "warningMessage": "string"
    }
  ]
}

Unauthorized

*/*

Schema

Example (from schema)

---

Schema

errors object[]
Array [
errorCode int32
errorTitle string
errorMessage string
]
warnings object[]
Array [
warningCode int32
warningTitle string
warningMessage string
]

{
  "errors": [
    {
      "errorCode": 0,
      "errorTitle": "string",
      "errorMessage": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": 0,
      "warningTitle": "string",
      "warningMessage": "string"
    }
  ]
}

Internal Server Error

*/*

Schema

Example (from schema)

---

Schema

errors object[]
Array [
errorCode int32
errorTitle string
errorMessage string
]
warnings object[]
Array [
warningCode int32
warningTitle string
warningMessage string
]

{
  "errors": [
    {
      "errorCode": 0,
      "errorTitle": "string",
      "errorMessage": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": 0,
      "warningTitle": "string",
      "warningMessage": "string"
    }
  ]
}

Loading...