Skip to main content
GET
cURL
Returns the customers belonging to the company identified by your API key. Each customer’s id is the reference ID you supplied at creation. taskType reflects the customer’s most recently created scheduled call, or null if they have none.

Limits and Ordering

Results are not paginated. Use limit (1–1000) to cap the number of customers returned; when omitted, all matching customers are returned. The limit is applied after test-customer filtering, and no particular ordering is guaranteed.

Filtering Test Customers

Use the test query parameter to control which customers are returned:
  • test=true - Returns only test customers
  • test=false or omitted - Returns only non-test customers (default behavior)
By default, the API only returns non-test customers to avoid mixing production data with test data.
test here is a query parameter on the read. The flag is named isTest in a customer’s body — on Create a Customer and on every customer response.

Authorizations

X-API-Key
string
header
required

Query Parameters

limit
integer

The maximum number of results to return

Required range: 1 <= x <= 1000
test
boolean

Filter for test customers only. If true, returns only test customers. If false or omitted, returns only non-test customers.

Response

Customer response

id
string
required

Unique identifier for the customer. This is your customer reference and should match your internal system's ID.

firstName
string
required

The first name of the customer

lastName
string
required

The last name of the customer

email
string<email> | null

Customer email address

birthday
string<date> | null

Customer birthday in YYYY-MM-DD format

ssnLastFour
string | null

Last 4 digits of SSN

timezone
string | null

Timezone of the customer (IANA timezone name, e.g., 'America/New_York', 'America/Los_Angeles')

phoneNumber
string | null

Phone number of the customer

streetAddress1
string | null

Street address line 1

streetAddress2
string | null

Street address line 2 (optional)

city
string | null

City name

state
string | null

State code (e.g., NY, CA)

zipCode
string | null

ZIP/postal code

doNotCall
boolean | null

Do not call the customer

doNotText
boolean | null

Do not text the customer

doNotEmail
boolean | null

Do not email the customer

bankruptcy
boolean | null

Whether the customer has an active bankruptcy compliance status

debtConsolidation
boolean | null

Whether the customer has an active debt-management or debt-consolidation compliance status

deceased
boolean | null

Whether the customer has an active deceased compliance status

militaryStatus
boolean | null

Whether the customer has an active military or servicemember compliance status

Whether threatened legal action has been reported. This is not attorney representation and has no attorney-representation hold.

isTest
boolean | null

Indicates if this is a test customer

taskType
string | null

Type of tasks created for the customer's automated call schedule

externalMetadata
object | null

Additional custom metadata about the customer