Skip to main content
GET
/
v2
/
customers
Get paginated list of customers
curl --request GET \
  --url https://api.carecycle.ai/v2/customers \
  --header 'x-api-key: <api-key>'
{
  "itemsTotal": 123,
  "currentPage": 123,
  "nextPage": 123,
  "prevPage": 123,
  "items": [
    {
      "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.

Query Parameters

​
page
number
default:1

GET /v2/customers Parameter

Required range: x >= 1
​
perPage
number
default:50

GET /v2/customers Parameter

Required range: 1 <= x <= 100
​
sortBy
enum<string>
default:createdAt

Field to sort by

Available options:
createdAt,
firstName,
lastName,
callerId
​
sortDirection
enum<string>
default:desc

Sort direction

Available options:
asc,
desc
​
search
string

Search query for filtering customers by name, phone, email, location, etc.

​
includeTestNumbers
boolean
default:false

Include test phone numbers in results

​
sourceIds
string

Filter customers by source IDs (comma-separated)

​
campaignIds
string

Filter customers by campaign IDs (comma-separated, OR logic)

​
campaignStatuses
string

Filter customers by customerCampaign status (comma-separated, OR logic - matches if customer has any of these statuses in any campaign)

​
policyStatuses
string

Filter customers by policy status (comma-separated, OR logic). Valid values: Active, Pending, Terminated, Suspended, Lapsed, Cancelled, Expired, Not Approved

​
startDate
string<date-time>

Filter customers created from this date (YYYY-MM-DD)

​
endDate
string<date-time>

Filter customers created up to this date (YYYY-MM-DD)

​
lastCallStartDate
string<date-time>

Filter customers by last call date from this date (YYYY-MM-DD)

​
lastCallEndDate
string<date-time>

Filter customers by last call date up to this date (YYYY-MM-DD)

Response

GET /v2/customers Positive response

​
itemsTotal
number
required
​
currentPage
number
required
​
nextPage
number | null
required
​
prevPage
number | null
required
​
items
object[]
required

List of customers