Skip to main content
GET
/
v2
/
inquiries
/
{id}
Get inquiry by id
curl --request GET \
  --url https://api.carecycle.ai/v2/inquiries/{id} \
  --header 'x-api-key: <api-key>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "customerCampaignId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "callId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "inquiry": "<string>",
  "response": "<string>",
  "status": "new",
  "primaryCategory": "<string>",
  "subcategory": "<string>",
  "severity": "<string>",
  "severityTriggers": "<string>",
  "suggestedHandling": "<string>",
  "handlingRationale": "<string>",
  "reasoning": "<string>",
  "escalationApplied": true,
  "additionalConcerns": "<string>",
  "resolutionType": "<string>",
  "notes": "<string>",
  "resolvedAt": "<string>",
  "resolvedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "carrierName": "<string>",
  "planName": "<string>",
  "planCode": "<string>",
  "agentName": "<string>",
  "firstName": "<string>",
  "lastName": "<string>",
  "callerId": "<string>",
  "customer": {
    "id": "<string>",
    "email": "<string>",
    "dateOfBirth": "<string>",
    "state": "<string>",
    "city": "<string>",
    "postalCode": "<string>",
    "address": "<string>",
    "language": "<string>",
    "timezone": "<string>",
    "enrollmentDate": "<string>",
    "effectiveDate": "<string>",
    "veteran": true,
    "medicareCard": "<string>",
    "medicaid": "<string>",
    "socialSecurityDisability": true,
    "existingCoverage": "<string>",
    "desiredCoverageStart": "<string>",
    "subsidyAmount": 123,
    "householdIncome": 123,
    "filingStatus": "<string>",
    "doNotCall": true,
    "doNotSMS": true,
    "doNotEmail": true,
    "doNotMail": true
  },
  "call": {
    "id": "<string>",
    "callerId": "<string>",
    "createdAt": "<string>",
    "disposition": "<string>",
    "durationMs": 123,
    "assistantType": "<string>",
    "summary": "<string>",
    "transcript": "<string>",
    "direction": "<string>",
    "cost": 123,
    "successEvaluation": "<string>",
    "endedReason": "<string>",
    "testFlag": true
  }
}

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

Inquiry ID

Response

GET /v2/inquiries/:id Positive response

Full inquiry with related customer and call data

id
string<uuid>
required
createdAt
string | null
required
updatedAt
string | null
required
customerCampaignId
string<uuid>
required
callId
string<uuid> | null
required
inquiry
string
required
response
string | null
required
status
enum<string>
required
Available options:
new,
pending_resolution,
unresolved,
resolved,
appointment_scheduled
primaryCategory
string | null
required
Maximum string length: 50
subcategory
string | null
required
Maximum string length: 100
severity
string | null
required
Maximum string length: 20
severityTriggers
required
suggestedHandling
string | null
required
Maximum string length: 50
handlingRationale
string | null
required
reasoning
string | null
required
escalationApplied
boolean | null
required
additionalConcerns
required
resolutionType
string | null
required
Maximum string length: 20
notes
string | null
required
resolvedAt
string | null
required
resolvedBy
string<uuid> | null
required
carrierName
string | null
required
planName
string | null
required
planCode
string | null
required
agentName
string | null
required
firstName
string | null
required
lastName
string | null
required
callerId
string | null
required
customer
object
required

Customer data associated with the inquiry

call
object
required

Call data associated with the inquiry