v1

latestOpenAPI 3.1.0MIT2026-07-22172693.3 KB

Retrieve the outcomes of AI phone calls placed through the Cair platform. Returns only completed or failed calls — calls still in progress are excluded. Results are scoped to your organization based on your authentication token.

get/api/aiphonecall/v1/results

Query parameters

dateFromstring date

Only return calls completed on or after this date (inclusive, from 00:00:00 UTC). Format: YYYY-MM-DD.

dateTostring date

Only return calls completed on or before this date (inclusive, through 23:59:59 UTC). Format: YYYY-MM-DD.

type'vob' | 'custom_vob_aba' | 'podiatry_vob' | 'vob_rpm' | 'denial' | 'claim_status_inquiry' | 'claim_status_wc' | 'claim_status_auto_pip' | 'custom_claim_status' | 'prior_auth' | 'prior_auth_cpt' | 'prior_auth_status_nds' | 'prior_auth_status_cpt' | 'credentialing' | 'credentialing_im' | 'appeal'

vob = Verification of Benefits, custom_vob_aba = Custom VOB for ABA, podiatry_vob = Podiatry VOB, vob_rpm = VOB for Remote Patient Monitoring, denial = Denied Claim Follow-up, claim_status_inquiry = General Claim Status, claim_status_wc = Workers' Comp Claim Status, claim_status_auto_pip = Auto/PIP Claim Status, custom_claim_status = Custom Claim Status, prior_auth = Prior Auth (Drug-based), prior_auth_cpt = Prior Auth (CPT-based), prior_auth_status_nds = Prior Auth Status (NDS), prior_auth_status_cpt = Prior Auth Status (CPT), credentialing = Credentialing Inquiry, credentialing_im = Credentialing - IM, appeal = Appeal Call

Filter by call type.

status'completed' | 'failed'

Filter by outcome. Omit to return both completed and failed calls.

source'platform' | 'api'

platform = from the Cair UI, api = via the API

Filter by how the call was initiated.

batchIdstring

Filter by batch upload ID to retrieve results for a specific CSV batch.

callIdstring

Look up a specific call by its unique call ID.

phoneNumberstring

Filter by the phone number that was called.

claimControlNumberstring

Filter to calls where this value matches (case-insensitive) either the payer claim control number (ICN extracted from the call, e.g. for iMagnum) or the claim control number from the call inputs.

pageinteger

Page number for pagination.

pageSizeinteger

Number of results per page.

sortOrder'desc' | 'asc'

desc = newest first, asc = oldest first

Sort direction by completion date.

Response

Call results retrieved successfully