Skip to main content
GET
/
customers
/
{id}
{
  "firstName": "<string>",
  "lastName": "<string>",
  "id": "<string>",
  "email": "[email protected]",
  "birthday": "2023-12-25",
  "ssnLastFour": "<string>",
  "timezone": "<string>",
  "phoneNumber": "<string>",
  "streetAddress1": "<string>",
  "streetAddress2": "<string>",
  "city": "<string>",
  "state": "<string>",
  "zipCode": "<string>",
  "doNotCall": true,
  "isTest": true,
  "taskType": "<string>",
  "externalMetadata": {}
}

Authorizations

​
X-API-Key
string
header
required

Path Parameters

​
id
string
required

ID of customer to retrieve

Response

Customer response

​
firstName
string
required

The first name of the customer

​
lastName
string
required

The last name of the customer

​
id
string

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

​
email
string<email>

Customer email address

​
birthday
string<date>

Customer birthday in YYYY-MM-DD format

​
ssnLastFour
string

Last 4 digits of SSN

​
timezone
string

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

​
phoneNumber
string

Phone number of the customer

​
streetAddress1
string

Street address line 1

​
streetAddress2
string

Street address line 2 (optional)

​
city
string

City name

​
state
string

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

​
zipCode
string

ZIP/postal code

​
doNotCall
boolean

Do not call the customer

​
isTest
boolean

Indicates if this is a test customer

​
taskType
string

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

​
externalMetadata
object

Additional custom metadata about the customer