CAcarecycle
Inquiries

List inquiries

List inquiries: questions or requests from callers that your team needs to follow up on. You can filter by status.

get/v2/inquiries

Request

  • Base URL
    https://api.carecycle.ai
  • URL
    https://api.carecycle.ai/v2/inquiries
  • Auth
    API key in header x-api-key

Query parameters

pagenumber

GET /v2/inquiries Parameter

perPagenumber

GET /v2/inquiries Parameter

statusstring

Filter inquiries by status. Single value or comma-separated list (e.g. 'new' or 'new,pending_resolution,unresolved')

agentNamestring

Filter inquiries by agent name

assignedTostring

Filter inquiries by assigned user. Single user id or comma-separated list of user ids.

priority'1' | '2' | '3' | '4' | '5' | 'none'

Filter to one priority tier, or 'none' for unscored inquiries

customerIdstring uuid

Filter inquiries to a single customer

searchstring

Search inquiries by customer name or phone number

sortBystring

Column to sort by. Supported: 'createdAt' (default), 'priority'. Unknown values fall back to createdAt.

sortDirection'asc' | 'desc'

Sort direction, defaults to desc. For 'priority', direction describes urgency: desc = most urgent (P1) first.

Response

GET /v2/inquiries Positive response

itemsTotalnumber required
currentPagenumber required
nextPagenumber nullable required
prevPagenumber nullable required

Changes

No recorded changes to this operation across all 2 revisions of this API.