---
title: "List Resource Records"
method: GET
path: "/integrations/v2/resource-records"
tags: ["Integrations Resource Records V2"]
---

# List Resource Records

`GET /integrations/v2/resource-records`

## Query parameters

- `filters` IntegrationsResourceRecordsFilters, required
  - `integrationId` string, nullable — Reference to the associated integration
  - `status` 'active' | 'inactive' — Represents whether the integration is active or inactive.
  - `type` 'locations' | 'practitioners' | 'visiting_reasons' | 'patients' | 'insurance_details' | 'appointments' | 'waitlist' | 'outreach' | 'appointment_types' | 'visit_statuses' | 'insurance_payers' | 'provider_resources' — Defines the type of resource record.
  - `patientStatus` 'created' | 'updated' | 'sync_created' | 'sync_failed' | 'existing_patient' — Defines appointment status options for integration
  - `patientMrnId` string, nullable — Medical Record Number (MRN) identifier for the patient
  - `patientPhoneNumber` string, nullable — Phone number of the patient
  - `patientEmail` string, nullable — Email address of the patient
  - `appointmentStatus` 'scheduled' | 'cancelled' | 'rescheduled' | 'reschedule_failed' | 'cancel_failed' | 'sync_created' | 'sync_updated' | 'sync_failed' — Defines appointment status options for integration
  - `appointmentAtGte` string, nullable — Start time of the appointment in ISO 8601 format
  - `appointmentAtLte` string, nullable — End time of the appointment in ISO 8601 format
  - `appointmentType` string, nullable — Type of the appointment
  - `paymentMethod` 'self_pay' | 'commercial_insurance' | 'medicare' | 'medicaid'
  - `locationId` string, nullable — Identifier for the location associated with the appointment
  - `practitionerId` string, nullable — Identifier for the practitioner associated with the appointment
  - `patientFlowMismatch` boolean, nullable — Indicates if there is a patient flow mismatch for the appointment
  - `patientCreatedSources` IntegrationPatientCreatedSource[] — Sources of the patient creation
  - `appointmentCreatedSources` IntegrationAppointmentCreatedSource[] — Sources of the appointment creation
  - `hasReminders` boolean, nullable — Indicates if the appointment has reminders set up
  - `isInsuranceCardUploaded` 'yes' | 'no' | 'skip' | 'not_applicable' — Defines possible answers for integration questions.
  - `isInsuranceCardUploadedToEHR` 'yes' | 'no' | 'skip' | 'not_applicable' — Defines possible answers for integration questions.
  - `isOcrExtracted` 'yes' | 'no' | 'skip' | 'not_applicable' — Defines possible answers for integration questions.
  - `hasStediResponse` 'yes' | 'no' | 'skip' | 'not_applicable' — Defines possible answers for integration questions.
  - `stediFinalStatus` 'active_insurance' | 'inactive_insurance' | 'unable_to_verify_insurance'
  - `debug` boolean, nullable — If true, includes debug information in the response
- `size` integer — Number of items per page
- `page` integer — Page number
- `search` string, nullable — Search keywords
- `start` string, date-time, nullable — Filter by start time (ISO 8601 format)
- `end` string, date-time, nullable — Filter by end time (ISO 8601 format)

## Response `200`

Successful Response

- IntegrationsResourceRecordsListResponse — Response model for a list of integrations resource records. Contains a list of IntegrationsResourceRecordsModel objects.
  - `integration_resource_records` IntegrationsResourceRecordsModel[] — List of integrations resource records
    - `teamId` string, nullable — ID of the team that owns this record
    - `createdBy` string, nullable — ID of the user who created this record
    - `updatedBy` string, nullable — ID of the user who last updated this record
    - `createdAt` string, date-time
    - `updatedAt` string, date-time
    - `_id` string, nullable — MongoDB document ObjectID
    - `logicalId` string, nullable — Unique identifier for the integration resource record
    - `integrationId` string, nullable — Reference to the associated integration
    - `config` union — type-specific configuration schema determined by 'type'.
      - AthenaResourcesPractitionersConfigOutput — Configuration for Athena Practitioners resource records.
        - `type` 'practitioners' — Type of the resource record. Must be 'practitioners'
        - `organizationId` string, nullable — Unique identifier for the organization in Athena system
        - `id` string, nullable — Unique identifier for the practitioner in Athena system
        - `npi` string, nullable — NPI of the practitioner (FHIR identifier with system http://hl7.org/fhir/sid/us-npi)
        - `name` string, nullable — Full name of the practitioner
        - `gender` string, nullable — Gender of the practitioner
        - `avatar` string, nullable — URL to the practitioner's avatar image
        - `summary` string, nullable — Short summary or bio for the practitioner
        - `qualification` string, nullable — Qualifications of the practitioner. Ex: MD, PhD etc.
        - `education` string, nullable — Educational background of the practitioner
        - `supervisorId` string, nullable — Practitioner's supervisor like Supervising Physician
        - `status` 'active' | 'inactive' — Represents whether the integration is active or inactive.
        - `languages` string[] — List of languages spoken by the practitioner
        - `specialties` IntegrationPractitionerSpecialty[] — Specialty details of the practitioner
          - `name` string, nullable — Name of the practitioner's specialty
          - `code` string, nullable — Code representing the practitioner's specialty
        - `locations` IntegrationLocations[] — List of locations associated with the practitioner
          - `locationId` string, nullable — Unique identifier for the location or department.
          - `locationName` string, nullable — Name of the location or department.
        - `workingHours` IntegrationWorkingHours — Simple day->windows configuration. Keys are weekday short names: mon,tue,wed,thu,fri,sat,sun. Values are lists of windows (e.g. [{start:'08:15', end:'11:00'}, ...]).
          - `mon` WorkingHoursWindow[] — Working-hour windows for Monday.
            - `start` string, required — Start time in HH:MM (24h) format
            - `end` string, required — End time in HH:MM (24h) format
          - `tue` WorkingHoursWindow[] — Working-hour windows for Tuesday.
            - `start` string, required — Start time in HH:MM (24h) format
            - `end` string, required — End time in HH:MM (24h) format
          - `wed` WorkingHoursWindow[] — Working-hour windows for Wednesday.
            - `start` string, required — Start time in HH:MM (24h) format
            - `end` string, required — End time in HH:MM (24h) format
          - `thu` WorkingHoursWindow[] — Working-hour windows for Thursday.
            - `start` string, required — Start time in HH:MM (24h) format
            - `end` string, required — End time in HH:MM (24h) format
          - `fri` WorkingHoursWindow[] — Working-hour windows for Friday.
            - `start` string, required — Start time in HH:MM (24h) format
            - `end` string, required — End time in HH:MM (24h) format
          - `sat` WorkingHoursWindow[] — Working-hour windows for Saturday.
            - `start` string, required — Start time in HH:MM (24h) format
            - `end` string, required — End time in HH:MM (24h) format
          - `sun` WorkingHoursWindow[] — Working-hour windows for Sunday.
            - `start` string, required — Start time in HH:MM (24h) format
            - `end` string, required — End time in HH:MM (24h) format
        - `preferred_visiting_reasons` string[], nullable — List of preferred visiting reasons for the practitioner. Leave empty to allow all reasons.
        - `minAgeTreated` integer, nullable — Minimum patient age (in years) this practitioner will treat. Ex: 18 for adults-only, 14 to allow younger patients.
        - `recordSource` 'from_upstream' | 'by_interactly'
      - AthenaResourcesLocationsConfigOutput — Configuration for Athena Locations resource records.
        - `type` 'locations' — Type of the resource record. Must be 'locations'
        - `id` string, nullable — Unique identifier for the location in Athena system
        - `name` string, nullable — Name of the location
        - `address` IntegrationAddress — Model representing an address associated with an integration. Ex: { "line": [ "501 Broad Street", "Suite 400" ], "city": "ROME", "state": "GA", "postalCode": "30161-3096" }
          - `line` string[], nullable — Street address or P.O. Box
          - `city` string, nullable — City of the address
          - `state` string, nullable — State or province of the address
          - `postalCode` string, nullable — Postal or ZIP code of the address
          - `country` string, nullable — Country of the address
          - `use` string, nullable — Usage qualifier for the address (e.g., home, work).
          - `type` string, nullable — Type qualifier for the address (e.g., postal, physical, both).
        - `position` IntegrationLocationPosition — Model representing geographical position of a location.
          - `latitude` union — Latitude of the location
            - string
            - number
          - `longitude` union — Longitude of the location
            - string
            - number
        - `telecom` IntegrationTelecom[] — Telecom information of the location
          - `system` string, nullable — The system that defines the type of telecom communication
          - `value` string, nullable — The actual telecom communication value (e.g., phone number)
          - `use` string, nullable — The purpose of the telecom communication (e.g., work, home)
          - `rank` integer, nullable — The rank or priority of the telecom communication
        - `status` 'active' | 'inactive' — Represents whether the integration is active or inactive.
        - `recordSource` 'from_upstream' | 'by_interactly'
        - `workingHours` IntegrationWorkingHours — Simple day->windows configuration. Keys are weekday short names: mon,tue,wed,thu,fri,sat,sun. Values are lists of windows (e.g. [{start:'08:15', end:'11:00'}, ...]).
          - `mon` WorkingHoursWindow[] — Working-hour windows for Monday.
            - `start` string, required — Start time in HH:MM (24h) format
            - `end` string, required — End time in HH:MM (24h) format
          - `tue` WorkingHoursWindow[] — Working-hour windows for Tuesday.
            - `start` string, required — Start time in HH:MM (24h) format
            - `end` string, required — End time in HH:MM (24h) format
          - `wed` WorkingHoursWindow[] — Working-hour windows for Wednesday.
            - `start` string, required — Start time in HH:MM (24h) format
            - `end` string, required — End time in HH:MM (24h) format
          - `thu` WorkingHoursWindow[] — Working-hour windows for Thursday.
            - `start` string, required — Start time in HH:MM (24h) format
            - `end` string, required — End time in HH:MM (24h) format
          - `fri` WorkingHoursWindow[] — Working-hour windows for Friday.
            - `start` string, required — Start time in HH:MM (24h) format
            - `end` string, required — End time in HH:MM (24h) format
          - `sat` WorkingHoursWindow[] — Working-hour windows for Saturday.
            - `start` string, required — Start time in HH:MM (24h) format
            - `end` string, required — End time in HH:MM (24h) format
          - `sun` WorkingHoursWindow[] — Working-hour windows for Sunday.
            - `start` string, required — Start time in HH:MM (24h) format
            - `end` string, required — End time in HH:MM (24h) format
        - `instructionsToReach` string, nullable — Instructions to reach the location. This can include details like entrance details, landmarks, parking information, or any other relevant directions.
      - AthenaResourcesVisitingReasonsConfig — Configuration for Athena Visiting Reasons resource records.
        - `type` 'visiting_reasons' — Type of the resource record. Must be 'visiting_reasons'
        - `reason` string, nullable — Name of the visiting reason
        - `reasonCode` string, nullable — Visiting Reason Code associated with the visiting reason
        - `applicableUseCase` 'scheduling' | 'cancel_reschedule' — Defines the type of use-case for an integration.
        - `isDefault` boolean, nullable — Indicates if this is a default Cancel Or Schedule Reason that should be offered when no other reason is selected. Note: Only considered for Appointment Cancellation/Reschedule in case reason code is not provided.
        - `status` 'active' | 'inactive' — Represents whether the integration is active or inactive.
        - `recordSource` 'from_upstream' | 'by_interactly'
      - AthenaResourcesPatientsConfigOutput — Configuration for Athena Patients resource records.
        - `type` 'patients' — Type of the resource record. Must be 'patients'
        - `status` 'active' | 'inactive' — Represents whether the integration is active or inactive.
        - `patientSyncId` string, nullable — Identifier for the sync request associated with the patient data
        - `outreach_conversation_id` string, nullable — Identifier of the conversation that triggered pre-appointment insurance outreach, so finalize_outreach_insurance_util can notify the right live call once the web-link flow completes. Set only by the pre-insurance-outreach tool API — not on patient creation, search, or any other path.
        - `patientStatus` 'created' | 'updated' | 'sync_created' | 'sync_failed' | 'existing_patient' — Defines appointment status options for integration
        - `is_created_in_ehr` boolean, nullable — Whether this patient has an actual record in the EHR. False for placeholder patient records created ahead of EHR creation (e.g. pre-appointment insurance outreach sent before the patient exists in the EHR) — flipped to True once the patient is created.
        - `patientId` string, nullable — Unique identifier for the patient in Athena system
        - `patientMrnId` string, nullable — Medical Record Number (MRN) identifier for the patient in Athena system
        - `firstName` string, nullable — First name of the patient
        - `lastName` string, nullable — Last name of the patient
        - `birthDate` string, nullable — Birth date of the patient in YYYY-MM-DD format
        - `gender` 'male' | 'female' | 'unknown' | 'Unknown' | 'prefer not to answer' — Defines gender options for integration
        - `phoneNumber` string, nullable — Contact phone number of the patient
        - `email` string, nullable — Contact email address of the patient
        - `pcp` string, nullable — Identifier for the patient's primary care provider
        - `rp` string, nullable — Identifier for the patient's referral provider
        - `notificationPreferences` PatientNotificationPreferences — Structured notification preferences for a patient used across request and response models.
          - `phone` boolean — Patient opted for Phone calls
          - `sms` boolean — Patient opted for SMS messages
          - `email` boolean — Patient opted for Emails
        - `patientCreatedSource` 'web' | 'app' | 'call' | 'sync' | 'existing_patient_through_web'
        - `address` IntegrationAddress — Model representing an address associated with an integration. Ex: { "line": [ "501 Broad Street", "Suite 400" ], "city": "ROME", "state": "GA", "postalCode": "30161-3096" }
          - `line` string[], nullable — Street address or P.O. Box
          - `city` string, nullable — City of the address
          - `state` string, nullable — State or province of the address
          - `postalCode` string, nullable — Postal or ZIP code of the address
          - `country` string, nullable — Country of the address
          - `use` string, nullable — Usage qualifier for the address (e.g., home, work).
          - `type` string, nullable — Type qualifier for the address (e.g., postal, physical, both).
        - `race` string, nullable — Race of the patient
        - `ethnicity` string, nullable — Ethnicity of the patient
        - `language` string, nullable — Preferred language of the patient
        - `recordSource` 'from_upstream' | 'by_interactly'
        - `trackingDetails` IntegrationTrackingDetails
          - `utm_source_id` string, nullable — UTM source label id for miscellaneous-information-item. This is used to track the source of traffic for the integration.
          - `utm_medium_id` string, nullable — UTM medium label id for miscellaneous-information-item. This is used to track the medium of traffic for the integration.
          - `utm_campaign_id` string, nullable — UTM campaign label id for miscellaneous-information-item. This is used to track the campaign of traffic for the integration.
          - `patient_creation` 'not_started' | 'in_progress' | 'completed'
          - `appointment_creation` 'not_started' | 'in_progress' | 'completed'
          - `insurance_flow_status` 'insurance_verification_not_required' | 'waiting_for_patient_to_upload_insurance' | 'insurance_uploaded' | 'insurance_verification_in_progress' | 'insurance_verification_success' | 'insurance_verification_failed' — Represents the flow status of the integration.
          - `utm_source` string, nullable — The source of the traffic (e.g., email, linkedin).
          - `utm_medium` string, nullable — The medium of the traffic (e.g., social, press_release).
          - `utm_campaign` string, nullable — The name of the campaign (e.g., product_launch).
          - `web_session_id` string, nullable — The unique identifier for the web session.
          - `conversation_id` string, nullable — The unique identifier for the conversation.
        - `consentDetails` IntegrationConsentDetails
          - `terms_accepted` boolean, nullable — Indicates whether the patient has accepted the terms and conditions for the session.
          - `terms_accepted_timestamp` string, date-time, nullable — Timestamp when the terms were accepted.
          - `captcha_verified` boolean, nullable — Indicates whether the captcha verification was successful.
          - `captcha_verified_timestamp` string, date-time, nullable — Timestamp when the captcha was verified.
          - `otp_verified` boolean, nullable — Indicates whether the OTP verification was successful.
          - `otp_verified_timestamp` string, date-time, nullable — Timestamp when the OTP was verified.
          - `otp_verified_for` string, nullable — The contact method (email/phone) for which the OTP was verified.
          - `privacy_accepted` boolean, nullable — Indicates whether the patient has accepted the privacy policy.
          - `privacy_accepted_timestamp` string, date-time, nullable — Timestamp when the privacy policy was accepted.
        - `insuranceCoverages` IntegrationInsuranceCoverageOutput[] — List of insurance coverages associated with the patient
          - `logical_id` string, nullable — Unique identifier for the insurance coverage
          - `payment_method` 'self_pay' | 'commercial_insurance' | 'medicare' | 'medicaid'
          - `is_primary_coverage` boolean, nullable — Indicates if this insurance coverage is the primary coverage.
          - `coverage_status` string, nullable — Status of the coverage as reported by the EHR (e.g. active, cancelled).
          - `documents_details` IntegrationDocumentsDetails
            - `insurance_card_front` IntegrationFileDetails — Model representing a practitioner's location.
              - …
            - `insurance_card_back` IntegrationFileDetails — Model representing a practitioner's location.
              - …
            - `insurance_card_combined` IntegrationFileDetails — Model representing a practitioner's location.
              - …
            - `personal_card_front` IntegrationFileDetails — Model representing a practitioner's location.
              - …
            - `personal_card_back` IntegrationFileDetails — Model representing a practitioner's location.
              - …
          - `insurance_details` IntegrationInsuranceDetails
            - `logical_id` string, nullable — Unique identifier for the insurance coverage
            - `member_id` string, nullable — Member ID of the insurance
            - `payer_id` string, nullable — Payer ID of the insurance
            - `member_type` 'primary' | 'dependent'
            - `relationship` string, nullable — Patient's Relationship with policy holder. Self in case of member_type is Primary.One of child, Spouse, Parent, Other in case of member_type is Dependent.
            - `payer_name` string, nullable — Name of the insurance payer
            - `primary_member_first_name` string, nullable — First name of the primary insurance member
            - `primary_member_last_name` string, nullable — Last name of the primary insurance member
            - `primary_member_gender` string, nullable — Gender of the primary insurance member
            - `primary_member_dob` string, nullable — DOB of the primary insurance member
            - `start_date` string, nullable — Start date of the insurance coverage
            - `end_date` string, nullable — End date of the insurance coverage
            - `insurance_id` string, nullable — Insurance ID number
            - `group_number` string, nullable — Insurance plan group number
            - `group_name` string, nullable — Insurance plan group name/description
          - `ocr_response` object, nullable — OCR response data for insurance card images.
          - `stedi_response` InsuranceVerificationResponse — Standardized response model for insurance verification API. This model ensures all responses follow a consistent structure, with the actual outcome conveyed through the status field.
            - `status` 'INSURANCE_COVERAGE_VERIFICATION_SUCCESS' | 'INSURANCE_COVERAGE_VERIFICATION_INVALID_DATA' | 'INSURANCE_COVERAGE_VERIFICATION_INACTIVE' | 'INSURANCE_COVERAGE_VERIFICATION_ERROR' — Status values for insurance coverage verification responses.
            - `statusReason` string, nullable — Reason for the current status of the insurance verification.
            - `fullResponse` object, nullable — Complete response data from the insurance verification API.
            - `miniResponse` object, nullable — A summarized version of the full response.
            - `summaryNotes` string, nullable — Additional notes summarizing the verification response.
            - `insuranceNameMatch` boolean, nullable — Indicates if the insurance name matches the expected payer.
            - `insurancePayerDetails` InsurancePayerDetails — Details of the insurance payer from the response.
              - …
            - `insuranceNameNotFoundInEHR` boolean, nullable — Indicates if the insurance name from the verification response was not found in the EHR system.
            - `stediRequests` unknown[], nullable — List of all HTTP request bodies sent to the Stedi eligibility API during verification.
              - …
          - `created_at` string, date-time
          - `updated_at` string, date-time
        - `insuranceResults` IntegrationInsuranceResults
          - `is_process_completed` 'yes' | 'no' | 'skip' | 'not_applicable' — Defines possible answers for integration questions.
          - `message` string, nullable — Additional information or message related to the insurance validation process.
          - `is_insurance_card_uploaded` 'yes' | 'no' | 'skip' | 'not_applicable' — Defines possible answers for integration questions.
          - `is_insurance_card_uploaded_to_ehr` 'yes' | 'no' | 'skip' | 'not_applicable' — Defines possible answers for integration questions.
          - `is_ocr_extracted` 'yes' | 'no' | 'skip' | 'not_applicable' — Defines possible answers for integration questions.
          - `stedi_final_status` 'active_insurance' | 'inactive_insurance' | 'unable_to_verify_insurance'
          - `stedi_final_summary` string, nullable — A summary of the final results from Stedi after insurance verification.
          - `is_coverage_added_to_ehr` 'yes' | 'no' | 'skip' | 'not_applicable' — Defines possible answers for integration questions.
          - `is_billing_notes_updated_to_ehr` 'yes' | 'no' | 'skip' | 'not_applicable' — Defines possible answers for integration questions.
          - `is_stedi_response_uploaded_to_ehr` 'yes' | 'no' | 'skip' | 'not_applicable' — Defines possible answers for integration questions.
        - `lastSyncedAt` string, nullable — Timestamp of the last successful sync for the appointment data
      - AthenaResourcesAppointmentsConfigOutput — Configuration for Athena Appointments resource records.
        - `type` 'appointments' — Type of the resource record. Must be 'appointments'
        - `status` 'active' | 'inactive' — Represents whether the integration is active or inactive.
        - `appointmentSyncId` string, nullable — Identifier for the sync request associated with the appointment data
        - `appointmentStatus` 'scheduled' | 'cancelled' | 'rescheduled' | 'reschedule_failed' | 'cancel_failed' | 'sync_created' | 'sync_updated' | 'sync_failed' — Defines appointment status options for integration
        - `visitStatus` string, nullable — Status of the visit associated with the appointment in Athena system
        - `appointmentId` string, nullable — Unique identifier for the appointment in Athena system
        - `patientId` string, nullable — Identifier for the patient associated with the appointment
        - `patientMrnId` string, nullable — Medical Record Number (MRN) identifier for the patient in Athena system
        - `patientFirstName` string, nullable — First name of the patient
        - `patientLastName` string, nullable — Last name of the patient
        - `patientPhoneNumber` string, nullable — Contact phone number of the patient
        - `patientEmail` string, nullable — Contact email address of the patient
        - `startTime` string, nullable — Date and time of the appointment
        - `duration` integer, nullable — Duration of the appointment in minutes
        - `locationId` string, nullable — Identifier for the location where the appointment is scheduled
        - `practitionerId` string, nullable — Identifier for the practitioner associated with the appointment
        - `visitReason` string, nullable — Reason for the patient's visit
        - `slotId` string, nullable — Identifier for the time slot of the appointment
        - `appointmentType` string, nullable — Legacy single appointment type value for the appointment. TODO: deprecate in favor of appointmentTypes.
        - `appointmentTypes` string[] — Normalized appointment type values for the appointment. Prefer this field over the legacy appointmentType field.
        - `notes` string, nullable — Additional notes or metadata associated with the appointment
        - `distanceMiles` number, nullable — Distance in miles related to the appointment
        - `paymentMethod` 'self_pay' | 'commercial_insurance' | 'medicare' | 'medicaid'
        - `insuranceHandlingStrategy` 'insurance_from_ehr' | 'insurance_from_uploaded_cards' — Defines strategies for handling insurance information during appointment scheduling and reminders.
        - `payerName` string, nullable — Name of the insurance payer associated with the appointment
        - `appointmentCreatedSource` 'web' | 'app' | 'call' | 'sync'
        - `recordSource` 'from_upstream' | 'by_interactly'
        - `visitDetails` IntegrationVisitDetailsOutput
          - `visit_reason_id` string, nullable — Identifier for the visit reason associated with the session.
          - `visit_reason` string, nullable — High-level reason for the visit.
          - `visit_reason_other` string, nullable — Additional details if the visit reason is categorized as 'Other' or 'Not Listed'.
          - `visit_type` 'first_time' | 'follow_up' — Defines gender options for integration
        - `insuranceCoverageId` string, nullable — Unique identifier for the insurance coverage
        - `patientFlowMismatch` boolean, nullable — Indicates whether there is a mismatch in the expected patient flow (e.g., new vs existing patient) for the appointment.
        - `lastSyncedAt` string, nullable — Timestamp of the last successful sync for the appointment data
        - `reminderDetails` IntegrationAppointmentReminder
          - `delivery_status` 'not_required' | 'queued' | 'delivered' | 'failed' | 'completed' | 'not_found_in_upstream' — Delivery status of reminder to patient.
          - `delivery_channels` IntegrationCommunicationChannel[] — Channels through which the reminder was sent (e.g., SMS, email, phone call).
          - `reason_for_reminder` string, nullable — Reason for sending the appointment reminder (e.g., upcoming appointment, missed appointment).
          - `delivery_timestamp` string, date-time, nullable — Timestamp when the reminder was delivered to the patient.
          - `response_channel` 'call' | 'sms' | 'email' — Defines communication channels.
          - `response_outcome` 'confirmed' | 'reschedule_requested' | 'cancellation_requested' | 'call_forwarded' | 'not_sure' | 'voicemail' | 'unable_to_leave_voicemail' | 'verification_failed' | 'unknown' — Patient's response to the appointment reminder.
          - `response_timestamp` string, date-time, nullable — Timestamp when the patient responded to the reminder.
        - `reminderHistory` IntegrationAppointmentReminder[] — History of reminders sent for the appointment along with their delivery and response details.
          - `delivery_status` 'not_required' | 'queued' | 'delivered' | 'failed' | 'completed' | 'not_found_in_upstream' — Delivery status of reminder to patient.
          - `delivery_channels` IntegrationCommunicationChannel[] — Channels through which the reminder was sent (e.g., SMS, email, phone call).
          - `reason_for_reminder` string, nullable — Reason for sending the appointment reminder (e.g., upcoming appointment, missed appointment).
          - `delivery_timestamp` string, date-time, nullable — Timestamp when the reminder was delivered to the patient.
          - `response_channel` 'call' | 'sms' | 'email' — Defines communication channels.
          - `response_outcome` 'confirmed' | 'reschedule_requested' | 'cancellation_requested' | 'call_forwarded' | 'not_sure' | 'voicemail' | 'unable_to_leave_voicemail' | 'verification_failed' | 'unknown' — Patient's response to the appointment reminder.
          - `response_timestamp` string, date-time, nullable — Timestamp when the patient responded to the reminder.
        - `finalReminderDetails` IntegrationAppointmentReminder
          - `delivery_status` 'not_required' | 'queued' | 'delivered' | 'failed' | 'completed' | 'not_found_in_upstream' — Delivery status of reminder to patient.
          - `delivery_channels` IntegrationCommunicationChannel[] — Channels through which the reminder was sent (e.g., SMS, email, phone call).
          - `reason_for_reminder` string, nullable — Reason for sending the appointment reminder (e.g., upcoming appointment, missed appointment).
          - `delivery_timestamp` string, date-time, nullable — Timestamp when the reminder was delivered to the patient.
          - `response_channel` 'call' | 'sms' | 'email' — Defines communication channels.
          - `response_outcome` 'confirmed' | 'reschedule_requested' | 'cancellation_requested' | 'call_forwarded' | 'not_sure' | 'voicemail' | 'unable_to_leave_voicemail' | 'verification_failed' | 'unknown' — Patient's response to the appointment reminder.
          - `response_timestamp` string, date-time, nullable — Timestamp when the patient responded to the reminder.
        - `insuranceRemindersHistory` IntegrationInsuranceReminderOutput[] — History of insurance reminders sent for the appointment along with their delivery and response details.
          - `channels` InsuranceReminderChannelStatus[] — Per-channel delivery tracking for the insurance reminder.
            - `channel` 'call' | 'sms' | 'email', required — Defines communication channels.
            - `opted` boolean — Whether this channel was opted in for the insurance reminder.
            - `delivery_status` 'not_required' | 'queued' | 'delivered' | 'failed' | 'completed' | 'not_found_in_upstream' — Delivery status of reminder to patient.
            - `delivery_timestamp` string, date-time, nullable — Timestamp when the reminder was delivered via this channel.
          - `reason_for_reminder` string, nullable — Reason for sending the insurance reminder (e.g., upcoming appointment, missed appointment).
          - `short_link_id` string, nullable — The outreach short link id this reminder was sent for, if applicable. Set by send_pre_appointment_insurance_outreach so callers can start a completion-timeout monitor keyed on it — not populated by other outreach flows.
          - `delivery_status` 'not_required' | 'queued' | 'delivered' | 'failed' | 'completed' | 'not_found_in_upstream', required — Delivery status of reminder to patient.
        - `insuranceResults` IntegrationInsuranceResults
          - `is_process_completed` 'yes' | 'no' | 'skip' | 'not_applicable' — Defines possible answers for integration questions.
          - `message` string, nullable — Additional information or message related to the insurance validation process.
          - `is_insurance_card_uploaded` 'yes' | 'no' | 'skip' | 'not_applicable' — Defines possible answers for integration questions.
          - `is_insurance_card_uploaded_to_ehr` 'yes' | 'no' | 'skip' | 'not_applicable' — Defines possible answers for integration questions.
          - `is_ocr_extracted` 'yes' | 'no' | 'skip' | 'not_applicable' — Defines possible answers for integration questions.
          - `stedi_final_status` 'active_insurance' | 'inactive_insurance' | 'unable_to_verify_insurance'
          - `stedi_final_summary` string, nullable — A summary of the final results from Stedi after insurance verification.
          - `is_coverage_added_to_ehr` 'yes' | 'no' | 'skip' | 'not_applicable' — Defines possible answers for integration questions.
          - `is_billing_notes_updated_to_ehr` 'yes' | 'no' | 'skip' | 'not_applicable' — Defines possible answers for integration questions.
          - `is_stedi_response_uploaded_to_ehr` 'yes' | 'no' | 'skip' | 'not_applicable' — Defines possible answers for integration questions.
        - `trackingDetails` IntegrationTrackingDetails
          - `utm_source_id` string, nullable — UTM source label id for miscellaneous-information-item. This is used to track the source of traffic for the integration.
          - `utm_medium_id` string, nullable — UTM medium label id for miscellaneous-information-item. This is used to track the medium of traffic for the integration.
          - `utm_campaign_id` string, nullable — UTM campaign label id for miscellaneous-information-item. This is used to track the campaign of traffic for the integration.
          - `patient_creation` 'not_started' | 'in_progress' | 'completed'
          - `appointment_creation` 'not_started' | 'in_progress' | 'completed'
          - `insurance_flow_status` 'insurance_verification_not_required' | 'waiting_for_patient_to_upload_insurance' | 'insurance_uploaded' | 'insurance_verification_in_progress' | 'insurance_verification_success' | 'insurance_verification_failed' — Represents the flow status of the integration.
          - `utm_source` string, nullable — The source of the traffic (e.g., email, linkedin).
          - `utm_medium` string, nullable — The medium of the traffic (e.g., social, press_release).
          - `utm_campaign` string, nullable — The name of the campaign (e.g., product_launch).
          - `web_session_id` string, nullable — The unique identifier for the web session.
          - `conversation_id` string, nullable — The unique identifier for the conversation.
      - AthenaResourcesAppointmentTypeConfigOutput — Configuration for Athena Appointment Type resource records.
        - `type` 'appointment_types' — Type of the resource record. Must be 'appointment_types'
        - `appointmentType` string, nullable — Type of appointment for the record
        - `appointmentCode` string, nullable — Code of the appointment type in EHR system
        - `appointmentDuration` integer, nullable — Duration of the appointment in minutes
        - `description` string, nullable — Description of the appointment type
        - `allowedUseCases` IntegrationUseCaseType[] — Optional list of allowed use-case (from enum). None indicates, Appointment Type is allowed is in all use-case.
        - `workingHours` IntegrationWorkingHours — Simple day->windows configuration. Keys are weekday short names: mon,tue,wed,thu,fri,sat,sun. Values are lists of windows (e.g. [{start:'08:15', end:'11:00'}, ...]).
          - `mon` WorkingHoursWindow[] — Working-hour windows for Monday.
            - `start` string, required — Start time in HH:MM (24h) format
            - `end` string, required — End time in HH:MM (24h) format
          - `tue` WorkingHoursWindow[] — Working-hour windows for Tuesday.
            - `start` string, required — Start time in HH:MM (24h) format
            - `end` string, required — End time in HH:MM (24h) format
          - `wed` WorkingHoursWindow[] — Working-hour windows for Wednesday.
            - `start` string, required — Start time in HH:MM (24h) format
            - `end` string, required — End time in HH:MM (24h) format
          - `thu` WorkingHoursWindow[] — Working-hour windows for Thursday.
            - `start` string, required — Start time in HH:MM (24h) format
            - `end` string, required — End time in HH:MM (24h) format
          - `fri` WorkingHoursWindow[] — Working-hour windows for Friday.
            - `start` string, required — Start time in HH:MM (24h) format
            - `end` string, required — End time in HH:MM (24h) format
          - `sat` WorkingHoursWindow[] — Working-hour windows for Saturday.
            - `start` string, required — Start time in HH:MM (24h) format
            - `end` string, required — End time in HH:MM (24h) format
          - `sun` WorkingHoursWindow[] — Working-hour windows for Sunday.
            - `start` string, required — Start time in HH:MM (24h) format
            - `end` string, required — End time in HH:MM (24h) format
        - `status` 'active' | 'inactive' — Represents whether the integration is active or inactive.
        - `recordSource` 'from_upstream' | 'by_interactly'
        - `isNewPatientAppointmentType` boolean, nullable — Indicates if the appointment type is for new patients
        - `isExistingPatientAppointmentType` boolean, nullable — Indicates if the appointment type is for existing patients
        - `freeSlotCode` string, nullable — Optional appointment code of another appointment type in this integration used to fetch open slots. When set, slot availability is queried using this code while booking still uses appointmentCode. Use when all slots are managed under a single generic type (e.g. 'Any 15') but bookings require a specific type code.
      - AthenaResourcesVisitStatusConfig — Configuration for Athena Appointment Type resource records.
        - `type` 'visit_statuses' — Type of the resource record. Must be 'visit_statuses'
        - `visitStatus` string, nullable — Visit Status Display Name in EHR System
        - `visitStatusCode` string, nullable — Code of the Visit Status in EHR system
        - `description` string, nullable — Description of the Visit Status
        - `status` 'active' | 'inactive' — Represents whether the integration is active or inactive.
        - `recordSource` 'from_upstream' | 'by_interactly'
      - AthenaResourcesInsurancePayersConfig — Configuration for Athena Insurance Payers resource records.
        - `type` 'insurance_payers' — Type of the resource record. Must be 'insurance_payers'
        - `insuranceName` string, nullable — Name of the insurance for the record
        - `insuranceCode` string, nullable — Code of the insurance in EHR system
        - `insurancePayorId` string, nullable — ID of the insurance payor in EHR system
        - `insurancePlanType` string, nullable — Type of the insurance plan in EHR system
        - `isSelfPay` boolean, nullable — Indicates if the insurance is a self-pay type
        - `status` 'active' | 'inactive' — Represents whether the integration is active or inactive.
        - `recordSource` 'from_upstream' | 'by_interactly'
      - AthenaResourcesOutreachConfigOutput — Configuration for Athena outreach resource records.
        - `type` 'outreach' — Type of the resource record. Must be 'outreach'
        - `status` 'active' | 'inactive' — Represents whether the integration is active or inactive.
        - `shortLinkId` string, nullable — Unique identifier for the outreach's short link in Athena system
        - `webSessionFlowType` 'scheduling_flow' | 'insurance_flow' | 'appointment_confirmation_flow' | 'pre_appointment_insurance_flow' — Defines the type of web session flow.
        - `communicationChannel` 'call' | 'sms' | 'email' — Defines communication channels.
        - `useCaseId` string, nullable — Identifier for the use case associated with the outreach
        - `locationId` string, nullable — Location identifier associated with the outreach.
        - `practitionerId` string, nullable — Provider identifier associated with the outreach.
        - `patientId` string, nullable — Patient identifier associated with the outreach.
        - `appointmentId` string, nullable — Appointment identifier associated with the outreach.
        - `paymentMethod` 'self_pay' | 'commercial_insurance' | 'medicare' | 'medicaid'
        - `timeoutSeconds` integer, nullable — Silence-timer window (seconds) configured when this pre-appointment outreach was sent — read back when the patient opens the link so the live call's silence timeout can be extended to match, via the call-control API.
      - ProviderResourcesResourceConfigOutput — Configuration for eCW 'generic scheduling resource' records. Some eCW deployments (e.g. FIN) never expose real per-practitioner Location/Practitioner FHIR resources for scheduling — instead there are a handful of generic scheduling-resource ids (e.g. 'fin--fin-ecw-prod--25780') that must be queried directly as the sole FHIR actor. eCW's own display label for these ("Provider 1", "Provider 2", ...) is meaningless and is reused across different real people at different locations, so the real practitioner identity is authoritatively maintained here as free text, with an optional link to a real PRACTITIONERS record for clinics where that link is meaningful.
        - `type` 'provider_resources' — Type of the resource record. Must be 'provider_resources'
        - `resourceId` string, nullable — Raw eCW FHIR actor id, e.g. 'fin--fin-ecw-prod--25780'. Used verbatim as 'Practitioner/{resourceId}' in Slot search and Appointment participant.
        - `resourceName` string, nullable — eCW's own generic label for this scheduling resource (e.g. 'Provider 1', 'Provider 2', 'Oviedo Provider', 'St Cloud Procedures'), as documented in the clinic's provider mapping sheet. Distinct from employeeName: this is eCW-side and often reused across different real people/locations, not a reliable identity by itself — kept for traceability back to the source mapping doc, not for display to patients.
        - `employeeName` string, required — Required patient-facing name of the employee assigned to this scheduling resource. eCW's own label (e.g. 'Provider 1') is a meaningless generic string reused across different real people/locations, so this field is authoritative. Existing practitionerName values are read as employeeName for backward compatibility and are written back under employeeName.
        - `linkedPractitionerId` string, nullable — Optional link to a real PRACTITIONERS resource record, for clinics where eCW's practitioner identity is meaningful (e.g. shared NPI lookups).
        - `locations` string[] — Default/display location(s) for this resource - resource-record ids (`_id`) into the existing LOCATIONS collection, matching the same id convention as `linkedPractitionerId` and every other INTEGRATIONS_LOCATIONS_SELECTION field (e.g. IntegrationInsuranceFlowSettings.allowed_locations). Informational only - the actual per-booking location for a fetched slot is discovered live from the FHIR response, not from this field, so day-of-week rotation does not need to be modeled here.
        - `workingHours` IntegrationWorkingHours — Simple day->windows configuration. Keys are weekday short names: mon,tue,wed,thu,fri,sat,sun. Values are lists of windows (e.g. [{start:'08:15', end:'11:00'}, ...]).
          - `mon` WorkingHoursWindow[] — Working-hour windows for Monday.
            - `start` string, required — Start time in HH:MM (24h) format
            - `end` string, required — End time in HH:MM (24h) format
          - `tue` WorkingHoursWindow[] — Working-hour windows for Tuesday.
            - `start` string, required — Start time in HH:MM (24h) format
            - `end` string, required — End time in HH:MM (24h) format
          - `wed` WorkingHoursWindow[] — Working-hour windows for Wednesday.
            - `start` string, required — Start time in HH:MM (24h) format
            - `end` string, required — End time in HH:MM (24h) format
          - `thu` WorkingHoursWindow[] — Working-hour windows for Thursday.
            - `start` string, required — Start time in HH:MM (24h) format
            - `end` string, required — End time in HH:MM (24h) format
          - `fri` WorkingHoursWindow[] — Working-hour windows for Friday.
            - `start` string, required — Start time in HH:MM (24h) format
            - `end` string, required — End time in HH:MM (24h) format
          - `sat` WorkingHoursWindow[] — Working-hour windows for Saturday.
            - `start` string, required — Start time in HH:MM (24h) format
            - `end` string, required — End time in HH:MM (24h) format
          - `sun` WorkingHoursWindow[] — Working-hour windows for Sunday.
            - `start` string, required — Start time in HH:MM (24h) format
            - `end` string, required — End time in HH:MM (24h) format
        - `status` 'active' | 'inactive' — Represents whether the integration is active or inactive.
        - `recordSource` 'from_upstream' | 'by_interactly'
  - `total` integer, nullable — Total number of integrations resource records available without pagination.

## Other responses

- `422` — Validation Error

## Changes

- **2026-08-27** `d69c17f1f601` — 1 breaking, 4 info
  - added `#/components/schemas/ProviderResourcesResourceConfig-Output` to the `integration_resource_records/items/config/anyOf[subschema #1]/` response property `oneOf` list for the response status `200`
  - added the enum value `provider_resources` to the property `type/anyOf[subschema #1: IntegrationResourceRecordType]/` of the `query` request parameter `filters`
  - added the optional property `integration_resource_records/items/config/anyOf[subschema #1]/oneOf[subschema #4: Patients]/insuranceCoverages/items/insurance_details/anyOf[subschema #1: Insurance Coverage]/group_name` to the response with the `200` status
  - added the optional property `integration_resource_records/items/config/anyOf[subschema #1]/oneOf[subschema #4: Patients]/insuranceCoverages/items/insurance_details/anyOf[subschema #1: Insurance Coverage]/group_number` to the response with the `200` status
  - …1 more
- …earlier changes not shown

[Full history](https://skmtc.dev/interactly/apis/interactly-api-4/changes/integrations/v2/resource-records/get.md)

---

[API](https://skmtc.dev/interactly/apis/interactly-api-4.md) · [All operations](https://skmtc.dev/interactly/apis/interactly-api-4/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/interactly/interactly-api-4/revisions/d69c17f1f601/schema)