Skip to main content
GET
/
v2
/
customers
/
{id}
Get customer by ID
curl --request GET \
  --url https://api.carecycle.ai/v2/customers/{id} \
  --header 'x-api-key: <api-key>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "updatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "clientId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "clientCustomerId": "<string>",
  "status": "Lead",
  "qualificationStatus": "Qualified",
  "intent": "High",
  "isDecisionMaker": true,
  "disqualificationReason": "<string>",
  "productInterest": "<string>",
  "productFamily": "<string>",
  "salutation": "<string>",
  "suffix": "<string>",
  "firstName": "<string>",
  "middleName": "<string>",
  "lastName": "<string>",
  "preferredName": "<string>",
  "callerId": "<string>",
  "lineType": "landline",
  "email": "<string>",
  "language": "<string>",
  "ethnicity": "<string>",
  "gender": "Male",
  "maritalStatus": "Single",
  "postalCode": "<string>",
  "timezone": "<string>",
  "state": "<string>",
  "city": "<string>",
  "county": "<string>",
  "address": "<string>",
  "address2": "<string>",
  "mbiNumber": "<string>",
  "medicareCard": true,
  "medicarePartADate": "<string>",
  "medicarePartBDate": "<string>",
  "medicaid": true,
  "medicaidNumber": "<string>",
  "socialSecurityDisability": true,
  "veteran": true,
  "vaNumber": "<string>",
  "healthSherpaCustomerId": "<string>",
  "householdIncome": -1,
  "annualIncome": -1,
  "filingStatus": "<string>",
  "dependentCount": -1,
  "subsidyAmount": -1,
  "subsidyEligible": true,
  "existingCoverage": "None",
  "existingCoveragePlanName": "<string>",
  "existingCoverageCarrier": "<string>",
  "desiredCoverageStartDate": "<string>",
  "currentSourceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "originalSourceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "agentName": "<string>",
  "agentNpn": -1,
  "carrierName": "<string>",
  "planName": "<string>",
  "planCode": "<string>",
  "carrierAssignedCustomerId": "<string>",
  "doNotCall": true,
  "doNotSMS": true,
  "doNotEmail": true,
  "doNotMail": true,
  "lastContactedAt": "<string>",
  "convertedAt": "<string>",
  "campaigns": [],
  "customFields": [],
  "policies": [],
  "prescriptions": [],
  "providers": [],
  "scopeOfAppointments": [],
  "dependents": [],
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "dateOfBirth": "<string>",
  "enrollmentDate": "<string>",
  "effectiveDate": "<string>",
  "desiredCoverageStart": "<string>",
  "totalCalls": 123,
  "lastCallDate": "<string>",
  "lastCallDisposition": "<string>",
  "source": {
    "id": "<string>",
    "name": "<string>",
    "sourceId": "<string>"
  }
}

Authorizations

​
x-api-key
string
header
required

API key required for authentication.

Keys begin with 'cc_' prefix. Get your API key from the Developer Dashboard.

Path Parameters

​
id
string<uuid>
required

Customer ID

Response

GET /v2/customers/:id Positive response

Customer

​
id
string<uuid>
required
​
createdBy
string<uuid> | null
required
​
updatedBy
string<uuid> | null
required
​
clientId
string<uuid>
required
​
clientCustomerId
string | null
required
Maximum string length: 255
​
status
enum<string> | null
required
Available options:
Lead,
Active,
Inactive
​
qualificationStatus
enum<string> | null
required
Available options:
Qualified,
Disqualified,
Pending Review,
Needs Information,
In Progress
​
intent
enum<string> | null
required
Available options:
High,
Medium,
Low,
Unknown
​
isDecisionMaker
boolean | null
required
​
disqualificationReason
string | null
required
Maximum string length: 255
​
productInterest
string | null
required
Maximum string length: 255
​
productFamily
string | null
required
Maximum string length: 255
​
salutation
string | null
required
Maximum string length: 50
​
suffix
string | null
required
Maximum string length: 50
​
firstName
string | null
required
Maximum string length: 255
​
middleName
string | null
required
Maximum string length: 255
​
lastName
string | null
required
Maximum string length: 255
​
preferredName
string | null
required
Maximum string length: 255
​
callerId
string
required
Maximum string length: 255
​
lineType
enum<string> | null
required
Available options:
landline,
mobile,
fixedVoip,
nonFixedVoip,
personal,
tollFree,
premium,
sharedCost,
uan,
voicemail,
pager,
unknown
​
email
string | null
required
Maximum string length: 255
​
language
string | null
required
Maximum string length: 50
​
ethnicity
string | null
required
Maximum string length: 50
​
gender
enum<string> | null
required
Available options:
Male,
Female,
Non-Binary,
Other,
Prefer Not to Say
​
maritalStatus
enum<string> | null
required
Available options:
Single,
Married,
Divorced,
Widowed,
Separated,
Domestic Partnership
​
postalCode
string | null
required
Maximum string length: 20
​
timezone
string | null
required
Maximum string length: 50
​
state
string | null
required
Maximum string length: 50
​
city
string | null
required
Maximum string length: 255
​
county
string | null
required
Maximum string length: 255
​
address
string | null
required
Maximum string length: 255
​
address2
string | null
required
Maximum string length: 255
​
mbiNumber
string | null
required
Maximum string length: 255
​
medicareCard
boolean | null
required
​
medicarePartADate
string | null
required
​
medicarePartBDate
string | null
required
​
medicaid
boolean | null
required
​
medicaidNumber
string | null
required
Maximum string length: 255
​
socialSecurityDisability
boolean | null
required
​
veteran
boolean | null
required
​
vaNumber
string | null
required
Maximum string length: 255
​
healthSherpaCustomerId
string | null
required
Maximum string length: 255
​
householdIncome
integer | null
required
Required range: -2147483648 <= x <= 2147483647
​
annualIncome
integer | null
required
Required range: -2147483648 <= x <= 2147483647
​
filingStatus
string | null
required
Maximum string length: 50
​
dependentCount
integer | null
required
Required range: -2147483648 <= x <= 2147483647
​
subsidyAmount
integer | null
required
Required range: -2147483648 <= x <= 2147483647
​
subsidyEligible
boolean | null
required
​
existingCoverage
enum<string> | null
required
Available options:
None,
Medicare Advantage,
Original Medicare,
Medicaid,
Employer,
Marketplace/ACA,
Other
​
existingCoveragePlanName
string | null
required
Maximum string length: 255
​
existingCoverageCarrier
string | null
required
Maximum string length: 255
​
desiredCoverageStartDate
string | null
required
​
currentSourceId
string<uuid> | null
required
​
originalSourceId
string<uuid> | null
required
​
agentName
string | null
required
Maximum string length: 255
​
agentNpn
integer | null
required
Required range: -2147483648 <= x <= 2147483647
​
carrierName
string | null
required
Maximum string length: 255
​
planName
string | null
required
Maximum string length: 255
​
planCode
string | null
required
Maximum string length: 255
​
carrierAssignedCustomerId
string | null
required
Maximum string length: 255
​
doNotCall
boolean | null
required
​
doNotSMS
boolean | null
required
​
doNotEmail
boolean | null
required
​
doNotMail
boolean | null
required
​
lastContactedAt
string | null
required
​
convertedAt
string | null
required
​
campaigns
object[]
required

Campaigns this customer is enrolled in

​
customFields
object[]
required

Structured custom fields with definitions and values

​
policies
object[]
required

List of policies associated with the customer

​
prescriptions
object[]
required

List of prescription names associated with the customer

​
providers
object[]
required

List of providers associated with the customer

​
scopeOfAppointments
object[]
required

List of scope of appointments associated with the customer

​
dependents
object[]
required

List of dependents associated with the customer

​
createdAt
string | null
​
updatedAt
string | null
​
dateOfBirth
string | null
​
enrollmentDate
string | null
​
effectiveDate
string | null
​
desiredCoverageStart
string | null
​
totalCalls
number

Total number of calls made to this customer

​
lastCallDate
string | null

ISO date of the last call

​
lastCallDisposition
string | null

Disposition of the most recent call

​
source
object

Source information for this customer