---
title: "Get Dental Inquiry"
method: GET
path: "/api/v0/dental/inquiries/{id}"
---

# Get Dental Inquiry

`GET /api/v0/dental/inquiries/{id}`

## Path parameters

- `id` string, required

## Response `200`

Successful Response

- ExternalDentalInquiry
  - `id` string, required — unique generated (uuid4) id for the inquiry
  - `status` 'SCHEDULED' | 'IN_PROGRESS' | 'SUCCESS' | 'UNSUCCESSFUL' | 'CANCELLED' | 'UNKNOWN', required — An enumeration.
  - `creation_ts` string, date-time, required — timestamp of when the inquiry was created
  - `summary` string — summary of the call results
  - `results` union — The output from the call containing the benefits or claims results.
    - ExternalClaimsQueryResults
      - `call_details` CallDetails[], required — The details of the placed calls including the call time in iso format, representative name, reference number, and transcript.
        - `call_end_time` string, date-time
        - `representative_name` string, required
        - `reference_number` string, required
        - `call_recording_url` string
        - `call_transcript_url` string
        - `call_transcript` string
        - `custom_answers` object
      - `status` 'NOT_FOUND' | 'UNPROCESSED' | 'APPROVED' | 'DENIED', required — An enumeration.
      - `similar_claim_dates` string[] — Similar claim dates of service in MM-DD-YYYY format, typically when the claim was not found.
      - `claims_info` ExternalClaimInfo[] — Details for matching claim(s) found during the inquiry.
        - `main_class` string — The claim info subtype, e.g. ClaimApprovedInfo, ClaimDeniedInfo, ClaimUnprocessedInfo.
        - `date_of_service` string — The date of service for the claim in MM-DD-YYYY format.
        - `claim_summary` string — A short summary of the claim status or outcome.
        - `date_received` string — The date the claim was received in MM-DD-YYYY format.
        - `date_processed_up_to` string — The date the claim was last processed or worked in MM-DD-YYYY format.
        - `turnaround_time` string — Expected turnaround time for an unprocessed claim.
        - `date_processed` string — The date the claim was processed in MM-DD-YYYY format.
        - `date_paid` string — The date the claim was paid in MM-DD-YYYY format.
        - `total_amount_paid` number — The total amount paid on the claim.
        - `adjustment_details` string — Adjustment or payment notes for the claim.
        - `code_details` ExternalClaimCodeDetails[] — Per-procedure-code payment details for the claim.
          - `procedure_code` string, required — The procedure code on the claim line.
          - `amount_paid` number — The amount paid for this procedure code.
          - `patient_responsibility` number — The patient responsibility for this procedure code.
          - `patient_applied_to_deductible` number — The amount applied to the patient deductible for this procedure code.
        - `claim_denial_reason` string — The reason the claim was denied.
        - `appeal_or_correction_info` string — Information about appealing or correcting the claim.
      - `claim_not_found_info` ExternalClaimNotFoundInfo
        - `patient_eligible_on_dos` boolean — Whether the patient was eligible on the date of service.
        - `mailing_address_or_payer_id` string — Claims mailing address or payer ID when no claim was found.
        - `timely_filing_limit` string — Timely filing limit information when no claim was found.
    - ExternalDentalEligibilityQueryResults
      - `call_details` CallDetails[], required — The details of the placed calls including the call time in iso format, representative name, reference number, and transcript.
        - `call_end_time` string, date-time
        - `representative_name` string, required
        - `reference_number` string, required
        - `call_recording_url` string
        - `call_transcript_url` string
        - `call_transcript` string
        - `custom_answers` object
      - `plan_information` PlanInformation — Coerce custom_answers values to str when loading legacy or mixed JSON.
        - `is_active` boolean
        - `plan_type` 'HMO' | 'PPO' | 'POS' | 'EPO' | 'OAP' | 'MEDICAID' | 'HMO_POS' | 'OTHER' — An enumeration.
        - `plan_name` string
        - `effective_date` string, date
        - `termination_date` string, date
        - `is_calendar_year_plan` boolean
        - `is_provider_in_network` boolean
        - `is_primary_insurance` boolean
        - `is_provider_pcp` boolean
        - `has_other_insurance` boolean
        - `is_self_funded` boolean
        - `has_out_of_state_coverage` boolean
        - `referral_required` boolean
        - `referral_info` string
        - `out_of_network_benefits` string
        - `custom_answers` object
      - `maximums` Maximums — Coerce custom_answers values to str when loading legacy or mixed JSON.
        - `name` string
        - `individual_deductible` number
        - `individual_deductible_used` number
        - `individual_deductible_resets_each_calendar_year` boolean
        - `individual_out_of_pocket_maximum` number
        - `individual_out_of_pocket_maximum_used` number
        - `family_deductible` number
        - `family_deductible_used` number
        - `family_out_of_pocket_maximum` number
        - `family_out_of_pocket_maximum_used` number
        - `coverage_limit` number
        - `coverage_limit_remaining` number
        - `orthodontic_deductible` number
        - `orthodontics_deductible_used` number
        - `orthodontics_coverage_limit` number
        - `orthodontics_coverage_limit_remaining` number
        - `orthodontics_lifetime_maximum` number
        - `orthodontics_lifetime_maximum_used` number
        - `orthodontics_maximum_benefits_per_case` number
        - `periodontic_maximum` string
        - `periodontic_maximum_used` number
        - `implant_maximum` string
        - `implant_maximum_used` number
        - `custom_answers` object
        - `deductible_remaining` number — The amount of deductible remaining for the patient. Calculated as the minimum of the individual and family deductible remaining.
        - `out_of_pocket_maximum_remaining` number — The amount of out of pocket maximum remaining for the patient. Calculated as the minimum of the individual and family out of pocket maximum remaining.
      - `treatment_history` object — The treatment history for the patient. The keys are dates in MM-DD-YYYY format and the values are a list of procedure codes performed on that date. See examples for more information.
      - `procedure_classes` object — A dict that maps from the different classes of procedures to their benefits. If a class is not covered, it may not have any other fields. See examples for more information.
      - `procedure_codes` array[] — A list that contains information from the different procedure codes and the requested benefits information for that code. See examples for more information.
        - unknown[]
          - unknown
      - `extra_info` ExtraDentalInfo — Coerce custom_answers values to str when loading legacy or mixed JSON.
        - `waiting_periods` string
        - `deductible_applies_to_preventive` boolean
        - `preventative_applies_to_maximum` boolean
        - `missing_tooth_clause` string
        - `has_pending_claims` boolean
        - `do_limited_and_routine_exam_share_frequencies` boolean
        - `do_all_exams_share_frequencies` boolean
        - `is_treatment_allowed_same_day_as_exam` boolean
        - `does_deductible_apply_to_xrays` boolean
        - `does_pano_share_frequency_with_fmx` boolean
        - `is_crown_claim_filed_on_seat_date` boolean
        - `is_four_quads_one_day_okay_srp_4341` boolean
        - `filing_deadline_days` integer
        - `orthodontics_payment_frequency` string
        - `orthodontics_age_limit` number
        - `orthodontics_age_limit_applies_to` string
        - `when_during_year_do_orthodontic_benefits_end` string
        - `orthodontics_work_in_progress_covered` boolean
        - `orthodontics_percentage_paid_at_banding` string
        - `are_orthodontics_remaining_payments_automatic` boolean
        - `orthodontics_codes_included_in_maximum` boolean
        - `are_orthodontic_records_billed_separately` boolean
        - `custom_answers` object
  - `request` ExternalDentalInquiryRequest, required
    - `type` 'CLAIMS_STATUS' | 'BENEFITS' | 'UNKNOWN', required — An enumeration.
    - `desired_completion_date` string, required — The requested completion date of the inquiry in MM-DD-YYYY format. Calls will typically be completed by the morning of the requested completion date, but in some cases may be completed earlier.
    - `patient_name` string, required — name of the patient
    - `dob` string, required — date of birth of the patient in MM-DD-YYYY format
    - `member_id` string, required — member id of the patient
    - `group_id` string — group id of the patient
    - `insurance_in_network` boolean — whether or not the provider is in-network. If it is not known, leave this field blank and it will be determined.
    - `npi` string — (deprecated, use billing_npi and rendering_npi instead) Ten digit NPI of the provider
    - `billing_npi` string — Ten digit NPI of the billing provider
    - `rendering_npi` string — Ten digit NPI of the rendering provider
    - `tax_id` string, required — Nine digit tax id of the provider
    - `external_id` string — An identifier which you can define and pass in with your creation request. This is useful for tracking a specific subgroup of inquiries. For instance, you can assign a unique external id to all inquiries for a specific provider on your platform.
    - `practice_billing_address` string — The billing address of the practice. If omitted, the address will be determined from the NPI.
    - `diagnosis_codes` string[] — Any diagnosis codes for the patient. If omitted, a general diagnosis code will be used.
    - `claims_date_of_service` string — The date of service for the claim in MM-DD-YYYY format. Only used for claims inquiries.
    - `claim_number` string — The claim number for the inquiry if provided by the user. Only used for claims inquiries.
    - `additional_info` string — Any additional information about the inquiry that is not covered by the other fields. This can be used to pass in any additional information for the request. Please check with the Health Harbor team before using this field as it may not be incorporated into the inquiry unless we are already aware of it.
    - `call_script_id` string — Optional ID of a call script belonging to your team. Use for eligibility/benefits inquiries to control which questions are asked. You can find call script IDs on the Accounts page in the dashboard. When provided, it must be a script your team created. For eligibility search, either benefits queries or this field may satisfy the requirement—see Health Harbor documentation.
    - `insurance` 'AETNA' | 'HEALTHPLEX' | 'HUMANA' | 'METLIFE' | 'UNITED_HEALTHCARE' | 'UNKNOWN' — An enumeration.
    - `benefits_query` ExternalDentalEligibilitySearchQuery[] — The benefits queries for the inquiry if provided by the user. Can be either a pre-defined set of questions (e.g. STANDARD for returning patients) or an ad-hoc defined set of codes.
    - `benefits_codes` string[] — Codes processed for a CODE_LOOKUP_BENEFITS or a CODE_LOOKUP_PRIOR_AUTH benefits inquiry. The first character in the CDT codes (D) can be optionally omitted.
    - `is_specialist` boolean — The type of provider making the inquiry. If the provider is a specialist (e.g. periodontist, oral surgeon), set this to True. If the provider is a dentist, set this to False. Defaults to False if not provided.
    - `insurance_payor_id` string — The payor id for the insurance. Usually five characters. For example, one payor id for Aetna is 60054.

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/healthharbor/apis/health-harbor.md) · [All operations](https://skmtc.net/healthharbor/apis/health-harbor/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/healthharbor/health-harbor/revisions/f1047899ad24/schema)