--- title: "Get Integration" method: GET path: "/integrations/v2/use-cases/{integration_use_case_id}" tags: ["Integrations Use Cases V2"] --- # Get Integration `GET /integrations/v2/use-cases/{integration_use_case_id}` ## Path parameters - `integration_use_case_id` string, required ## Response `200` Successful Response - IntegrationsUseCasesResponse — Response model for a single integration use case. Contains a IntegrationsUseCasesModel object. - `integration_use_case` IntegrationsUseCasesModel, required — Main integration model holding configuration and audit details. - `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 use-case - `integrationId` string, nullable — Reference to the associated integration - `schedulerNames` string[] — List of associated scheduler names - `config` union — type-specific configuration schema determined by 'type'. - AppointmentReminderWithSheetUseCaseConfigOutput - `displayName` string, nullable — Friendly name for the use-case. You can change this to better identify the use-case. - `assistantId` string, nullable — ID of the assistant associated with this use-case - `status` 'active' | 'inactive' — Represents whether the integration is active or inactive. - `timezone` string, nullable — Timezone for scheduling and notifications - `type` 'appointment_reminder_with_sheet' — Type of the use-case. Must be 'appointment_reminder_with_sheet' - `name` string, nullable — Reminders for newly scheduled patient appointments - `sheetLink` string, nullable — Link to the appointment data sheet - `actions` UseCasesActionsConfig[] — List of actions associated with the use-case - `logicalId` string, nullable — Unique identifier for the use case action - `templateName` string, nullable — Name of the template used for the action - `communicationPreference` 'call' | 'sms' | 'email' | 'call_and_sms' | 'call_and_email' | 'sms_and_email' | 'call_and_sms_and_email' | 'call_or_sms' | 'call_or_email' | 'sms_or_email' | 'call_or_sms_or_email', nullable — Defines the communication preferences for a use-case. - `context` string, nullable — Contextual information for the action - `reportEmails` string[], nullable — List of email addresses to send the reports to - `daysWindow` integer, nullable — Number of days in advance to check for the action - `status` 'active' | 'inactive', nullable — Represents whether the integration is active or inactive. - `schedule` union — You can schedule actions to run at specific times or intervals. - OneTimeTriggerRule - … - DaysTriggerRule - … - LabReminderWithSheetUseCaseConfigOutput - `displayName` string, nullable — Friendly name for the use-case. You can change this to better identify the use-case. - `assistantId` string, nullable — ID of the assistant associated with this use-case - `status` 'active' | 'inactive' — Represents whether the integration is active or inactive. - `timezone` string, nullable — Timezone for scheduling and notifications - `type` 'lab_reminder_with_sheet' — Type of the use-case. Must be 'lab_reminder_with_sheet' - `name` string, nullable — Notifications for lab results availability - `sheetLink` string, nullable — Link to the lab results data sheet - `actions` UseCasesActionsConfig[] — List of actions associated with the use-case - `logicalId` string, nullable — Unique identifier for the use case action - `templateName` string, nullable — Name of the template used for the action - `communicationPreference` 'call' | 'sms' | 'email' | 'call_and_sms' | 'call_and_email' | 'sms_and_email' | 'call_and_sms_and_email' | 'call_or_sms' | 'call_or_email' | 'sms_or_email' | 'call_or_sms_or_email', nullable — Defines the communication preferences for a use-case. - `context` string, nullable — Contextual information for the action - `reportEmails` string[], nullable — List of email addresses to send the reports to - `daysWindow` integer, nullable — Number of days in advance to check for the action - `status` 'active' | 'inactive', nullable — Represents whether the integration is active or inactive. - `schedule` union — You can schedule actions to run at specific times or intervals. - OneTimeTriggerRule - … - DaysTriggerRule - … - AppointmentReminderUseCaseConfigOutput - `displayName` string, nullable — Friendly name for the use-case. You can change this to better identify the use-case. - `assistantId` string, nullable — ID of the assistant associated with this use-case - `status` 'active' | 'inactive' — Represents whether the integration is active or inactive. - `timezone` string, nullable — Timezone for scheduling and notifications - `type` 'appointment_reminder' — Type of the use-case. Must be 'appointment_reminder' - `name` string, nullable — Reminders for newly scheduled patient appointments - `allowedLocations` string[], nullable — List of location ids for which the appointment reminder use-case applies. - `allowedPractitioners` string[], nullable — List of practitioner ids for which the appointment reminder use-case applies. - `allowedVisitStatuses` IntegrationAppointmentVisitStatus[] — (Legacy) List of visit statuses of the appointments for which the appointment reminder use-case applies. - `allowedVisitStatusesIds` string[], nullable — List of visit status codes for which the appointment reminder use-case applies. - `allowedAppointmentTypeIds` string[], nullable — List of appointment type resource record ids for which the appointment reminder use-case applies. - `allowedAppointmentTypes` IntegrationAppointmentTypes[] — Deprecated legacy appointment type names kept for backwards compatibility. TODO: remove after migrating to allowedAppointmentTypeIds. - `actions` UseCasesActionsConfig[] — List of actions associated with the use-case - `logicalId` string, nullable — Unique identifier for the use case action - `templateName` string, nullable — Name of the template used for the action - `communicationPreference` 'call' | 'sms' | 'email' | 'call_and_sms' | 'call_and_email' | 'sms_and_email' | 'call_and_sms_and_email' | 'call_or_sms' | 'call_or_email' | 'sms_or_email' | 'call_or_sms_or_email', nullable — Defines the communication preferences for a use-case. - `context` string, nullable — Contextual information for the action - `reportEmails` string[], nullable — List of email addresses to send the reports to - `daysWindow` integer, nullable — Number of days in advance to check for the action - `status` 'active' | 'inactive', nullable — Represents whether the integration is active or inactive. - `schedule` union — You can schedule actions to run at specific times or intervals. - OneTimeTriggerRule - … - DaysTriggerRule - … - FinalAppointmentNotificationUseCaseConfigOutput - `displayName` string, nullable — Friendly name for the use-case. You can change this to better identify the use-case. - `assistantId` string, nullable — ID of the assistant associated with this use-case - `status` 'active' | 'inactive' — Represents whether the integration is active or inactive. - `timezone` string, nullable — Timezone for scheduling and notifications - `type` 'final_appointment_notification' — Type of the use-case. Must be 'final_appointment_notification' - `name` string, nullable — Final notifications for scheduled patient appointments - `allowedLocations` string[], nullable — List of location ids for which the final notification should be sent. - `allowedPractitioners` string[], nullable — List of practitioner ids for which the final notification should be sent. - `allowedVisitStatuses` IntegrationAppointmentVisitStatus[] — (Legacy) List of visit statuses of the appointments for which the final notification should be sent. - `allowedVisitStatusesIds` string[], nullable — List of visit status codes for which the final notification should be sent. - `allowedAppointmentTypeIds` string[], nullable — List of appointment type resource record ids for which the final notification should be sent. - `allowedAppointmentTypes` IntegrationAppointmentTypes[] — Deprecated legacy appointment type names kept for backwards compatibility. TODO: remove after migrating to allowedAppointmentTypeIds. - `actions` UseCasesActionsConfig[] — List of actions associated with the use-case - `logicalId` string, nullable — Unique identifier for the use case action - `templateName` string, nullable — Name of the template used for the action - `communicationPreference` 'call' | 'sms' | 'email' | 'call_and_sms' | 'call_and_email' | 'sms_and_email' | 'call_and_sms_and_email' | 'call_or_sms' | 'call_or_email' | 'sms_or_email' | 'call_or_sms_or_email', nullable — Defines the communication preferences for a use-case. - `context` string, nullable — Contextual information for the action - `reportEmails` string[], nullable — List of email addresses to send the reports to - `daysWindow` integer, nullable — Number of days in advance to check for the action - `status` 'active' | 'inactive', nullable — Represents whether the integration is active or inactive. - `schedule` union — You can schedule actions to run at specific times or intervals. - OneTimeTriggerRule - … - DaysTriggerRule - … - LabReminderUseCaseConfigOutput - `displayName` string, nullable — Friendly name for the use-case. You can change this to better identify the use-case. - `assistantId` string, nullable — ID of the assistant associated with this use-case - `status` 'active' | 'inactive' — Represents whether the integration is active or inactive. - `timezone` string, nullable — Timezone for scheduling and notifications - `type` 'lab_reminder' — Type of the use-case. Must be 'lab_reminder' - `name` string, nullable — Notifications for lab results availability - `actions` UseCasesActionsConfig[] — List of actions associated with the use-case - `logicalId` string, nullable — Unique identifier for the use case action - `templateName` string, nullable — Name of the template used for the action - `communicationPreference` 'call' | 'sms' | 'email' | 'call_and_sms' | 'call_and_email' | 'sms_and_email' | 'call_and_sms_and_email' | 'call_or_sms' | 'call_or_email' | 'sms_or_email' | 'call_or_sms_or_email', nullable — Defines the communication preferences for a use-case. - `context` string, nullable — Contextual information for the action - `reportEmails` string[], nullable — List of email addresses to send the reports to - `daysWindow` integer, nullable — Number of days in advance to check for the action - `status` 'active' | 'inactive', nullable — Represents whether the integration is active or inactive. - `schedule` union — You can schedule actions to run at specific times or intervals. - OneTimeTriggerRule - … - DaysTriggerRule - … - AppointmentSchedulingUseCaseConfigOutput - `displayName` string, nullable — Friendly name for the use-case. You can change this to better identify the use-case. - `assistantId` string, nullable — ID of the assistant associated with this use-case - `status` 'active' | 'inactive' — Represents whether the integration is active or inactive. - `timezone` string, nullable — Timezone for scheduling and notifications - `type` 'appointment_scheduling' — Type of the use-case. Must be 'appointment_scheduling' - `name` string, nullable — Notifications for appointment scheduling - `communicationPreference` 'sms' | 'email' | 'sms_and_email' | 'sms_or_email', nullable — SMS and Email communication preferences only (no call). - `insurance_flow_settings` object, nullable — Optional configuration for insurance flow settings to be applied during appointment scheduling - `status` 'active' | 'inactive' — Represents whether the integration is active or inactive. - `patient_types` IntegrationPatientTypes[] — List of patient types that this insurance flow settings applies to - `verification_phase` 'before_appointment' | 'after_appointment', nullable — Defines verification phases for insurance verification. - `upload_insurance_cards` 'active' | 'inactive', nullable — Represents whether the integration is active or inactive. - `do_stedi_verification` 'active' | 'inactive', nullable — Represents whether the integration is active or inactive. - `is_stedi_sandbox` boolean, nullable — Whether to use the Stedi sandbox environment (test API key) instead of production for eligibility checks. Turn off for production use. - `skip_card_upload` boolean, nullable — Whether patients can submit insurance details without uploading a card image, and without an existing EHR patient record. Enables pre-appointment outreach to be sent before the patient has been created in the EHR. - `stedi_npi_source` 'group_npi' | 'provider_npi', nullable — Defines which NPI to send when calling Stedi for insurance verification. - `ocr_workflow_id` string, nullable — Workflow used to read insurance cards. Leave empty to use the built-in OCR service. Selecting one moves the extraction prompt, model and fallbacks into the workflow, where they can be changed without a deploy. - `ocr_workflow_version` integer, nullable — Version of the OCR workflow to run. Pin a version so an edit in the dashboard does not reach production until it is promoted here; leave empty to always run the latest. - `ocr_fallback_to_service` 'active' | 'inactive', nullable — Represents whether the integration is active or inactive. - `update_result_on` IntegrationInsuranceUpdateResultOn[] — List of insurance flow events that should trigger an update to the insurance information to billing notes section in the EHR. Empty list means insurance information will not be updated to billing notes. - `upload_stedi_responses` IntegrationInsuranceUploadStediResponseOn[] — List of insurance flow events that should trigger an upload of Stedi responses to the EHR. Empty list means no Stedi responses will be uploaded. - `failure_reminder` 'no_reminders' | 'remind_once' | 'remind_until_verification_success' — Defines triggers for sending reminders to patients on insurance verification failure. - `allowed_visit_statuses` IntegrationAppointmentVisitStatus[] — (Legacy) List of visit statuses of the appointments for which the insurance flow settings should be applied. - `allowed_visit_statuses_ids` string[], nullable — List of visit status codes for which the insurance flow settings should be applied. - `allowed_appointment_type_ids` string[], nullable — List of appointment type resource record ids for which the insurance flow settings should be applied. - `allowed_appointment_types` IntegrationAppointmentTypes[] — Deprecated legacy appointment type names kept for backwards compatibility. TODO: remove after migrating to allowed_appointment_type_ids. - `allowed_locations` string[], nullable — List of location ids for which the insurance flow settings apply. - `allowed_practitioners` string[], nullable — List of practitioner ids for which the insurance flow settings apply. - AppointmentCancellationUseCaseConfigOutput - `displayName` string, nullable — Friendly name for the use-case. You can change this to better identify the use-case. - `assistantId` string, nullable — ID of the assistant associated with this use-case - `status` 'active' | 'inactive' — Represents whether the integration is active or inactive. - `timezone` string, nullable — Timezone for scheduling and notifications - `type` 'appointment_cancellation' — Type of the use-case. Must be 'appointment_cancellation' - `name` string, nullable — Notifications for appointment cancellation - `communicationPreference` 'sms' | 'email' | 'sms_and_email' | 'sms_or_email', nullable — SMS and Email communication preferences only (no call). - AppointmentReschedulingUseCaseConfigOutput - `displayName` string, nullable — Friendly name for the use-case. You can change this to better identify the use-case. - `assistantId` string, nullable — ID of the assistant associated with this use-case - `status` 'active' | 'inactive' — Represents whether the integration is active or inactive. - `timezone` string, nullable — Timezone for scheduling and notifications - `type` 'appointment_rescheduling' — Type of the use-case. Must be 'appointment_rescheduling' - `name` string, nullable — Notifications for appointment rescheduling - `communicationPreference` 'sms' | 'email' | 'sms_and_email' | 'sms_or_email', nullable — SMS and Email communication preferences only (no call). - AppointmentSchedulingWithWaitlistUseCaseConfigOutput - `displayName` string, nullable — Friendly name for the use-case. You can change this to better identify the use-case. - `assistantId` string, nullable — ID of the assistant associated with this use-case - `status` 'active' | 'inactive' — Represents whether the integration is active or inactive. - `timezone` string, nullable — Timezone for scheduling and notifications - `type` 'appointment_scheduling_with_waitlist' — Type of the use-case. Must be 'appointment_scheduling_with_waitlist' - `name` string, nullable — Notifications for appointment scheduling with waitlist - MedicationRefillUseCaseConfigOutput - `displayName` string, nullable — Friendly name for the use-case. You can change this to better identify the use-case. - `assistantId` string, nullable — ID of the assistant associated with this use-case - `status` 'active' | 'inactive' — Represents whether the integration is active or inactive. - `timezone` string, nullable — Timezone for scheduling and notifications - `type` 'medication_refill' — Type of the use-case. Must be 'medication_refill' - `name` string, nullable — Medication refills - InvoiceBillingUseCaseConfigOutput - `displayName` string, nullable — Friendly name for the use-case. You can change this to better identify the use-case. - `assistantId` string, nullable — ID of the assistant associated with this use-case - `status` 'active' | 'inactive' — Represents whether the integration is active or inactive. - `timezone` string, nullable — Timezone for scheduling and notifications - `type` 'invoice_enquiry' — Type of the use-case. Must be 'invoice_enquiry' - `name` string, nullable — Invoice and billing notifications - WebSchedulingUseCaseConfigOutput - `displayName` string, nullable — Friendly name for the use-case. You can change this to better identify the use-case. - `assistantId` string, nullable — ID of the assistant associated with this use-case - `status` 'active' | 'inactive' — Represents whether the integration is active or inactive. - `timezone` string, nullable — Timezone for scheduling and notifications - `type` 'web_scheduling' — Type of the use-case. Must be 'web_scheduling' - `name` string, nullable — Web scheduling for patient appointments - `start_offset_days` integer — Number of days to offset the first available appointment shown to patients - `disclaimer_message` string — Disclaimer displayed alongside the scheduling experience to guide patients - `redirect_url` string — URL, patient is redirected if he/she is an existing patient - `insurance_flow_settings` object, nullable — Optional configuration for insurance flow settings to be applied during web scheduling - `status` 'active' | 'inactive' — Represents whether the integration is active or inactive. - `patient_types` IntegrationPatientTypes[] — List of patient types that this insurance flow settings applies to - `verification_phase` 'before_appointment' | 'after_appointment', nullable — Defines verification phases for insurance verification. - `upload_insurance_cards` 'active' | 'inactive', nullable — Represents whether the integration is active or inactive. - `do_stedi_verification` 'active' | 'inactive', nullable — Represents whether the integration is active or inactive. - `is_stedi_sandbox` boolean, nullable — Whether to use the Stedi sandbox environment (test API key) instead of production for eligibility checks. Turn off for production use. - `skip_card_upload` boolean, nullable — Whether patients can submit insurance details without uploading a card image, and without an existing EHR patient record. Enables pre-appointment outreach to be sent before the patient has been created in the EHR. - `stedi_npi_source` 'group_npi' | 'provider_npi', nullable — Defines which NPI to send when calling Stedi for insurance verification. - `ocr_workflow_id` string, nullable — Workflow used to read insurance cards. Leave empty to use the built-in OCR service. Selecting one moves the extraction prompt, model and fallbacks into the workflow, where they can be changed without a deploy. - `ocr_workflow_version` integer, nullable — Version of the OCR workflow to run. Pin a version so an edit in the dashboard does not reach production until it is promoted here; leave empty to always run the latest. - `ocr_fallback_to_service` 'active' | 'inactive', nullable — Represents whether the integration is active or inactive. - `update_result_on` IntegrationInsuranceUpdateResultOn[] — List of insurance flow events that should trigger an update to the insurance information to billing notes section in the EHR. Empty list means insurance information will not be updated to billing notes. - `upload_stedi_responses` IntegrationInsuranceUploadStediResponseOn[] — List of insurance flow events that should trigger an upload of Stedi responses to the EHR. Empty list means no Stedi responses will be uploaded. - `failure_reminder` 'no_reminders' | 'remind_once' | 'remind_until_verification_success' — Defines triggers for sending reminders to patients on insurance verification failure. - `allowed_visit_statuses` IntegrationAppointmentVisitStatus[] — (Legacy) List of visit statuses of the appointments for which the insurance flow settings should be applied. - `allowed_visit_statuses_ids` string[], nullable — List of visit status codes for which the insurance flow settings should be applied. - `allowed_appointment_type_ids` string[], nullable — List of appointment type resource record ids for which the insurance flow settings should be applied. - `allowed_appointment_types` IntegrationAppointmentTypes[] — Deprecated legacy appointment type names kept for backwards compatibility. TODO: remove after migrating to allowed_appointment_type_ids. - `allowed_locations` string[], nullable — List of location ids for which the insurance flow settings apply. - `allowed_practitioners` string[], nullable — List of practitioner ids for which the insurance flow settings apply. - InsuranceReminderUseCaseConfigOutput - `displayName` string, nullable — Friendly name for the use-case. You can change this to better identify the use-case. - `assistantId` string, nullable — ID of the assistant associated with this use-case - `status` 'active' | 'inactive' — Represents whether the integration is active or inactive. - `timezone` string, nullable — Timezone for scheduling and notifications - `type` 'insurance_reminder' — Type of the use-case. Must be 'insurance_reminder' - `name` string, nullable — Reminding patients about insurance - `allowedVisitStatuses` IntegrationAppointmentVisitStatus[] — (Legacy) List of visit statuses of the appointments for which the insurance reminder use-case applies. - `allowedVisitStatusesIds` string[], nullable — List of visit status codes for which the insurance reminder use-case applies.. - `allowedAppointmentTypeIds` string[], nullable — List of appointment type resource record ids for which the final notification should be sent. - `allowedAppointmentTypes` IntegrationAppointmentTypes[] — Deprecated legacy appointment type names kept for backwards compatibility. TODO: remove after migrating to allowedAppointmentTypeIds. - `reminderMaxAttempts` integer, nullable — Maximum number of reminder attempts before giving up. - `actions` UseCasesActionsConfig[] — List of actions associated with the use-case - `logicalId` string, nullable — Unique identifier for the use case action - `templateName` string, nullable — Name of the template used for the action - `communicationPreference` 'call' | 'sms' | 'email' | 'call_and_sms' | 'call_and_email' | 'sms_and_email' | 'call_and_sms_and_email' | 'call_or_sms' | 'call_or_email' | 'sms_or_email' | 'call_or_sms_or_email', nullable — Defines the communication preferences for a use-case. - `context` string, nullable — Contextual information for the action - `reportEmails` string[], nullable — List of email addresses to send the reports to - `daysWindow` integer, nullable — Number of days in advance to check for the action - `status` 'active' | 'inactive', nullable — Represents whether the integration is active or inactive. - `schedule` union — You can schedule actions to run at specific times or intervals. - OneTimeTriggerRule - … - DaysTriggerRule - … - AppointmentEnquiryUseCaseConfigOutput - `displayName` string, nullable — Friendly name for the use-case. You can change this to better identify the use-case. - `assistantId` string, nullable — ID of the assistant associated with this use-case - `status` 'active' | 'inactive' — Represents whether the integration is active or inactive. - `timezone` string, nullable — Timezone for scheduling and notifications - `type` 'appointment_enquiry' — Type of the use-case. Must be 'appointment_enquiry' - `name` string, nullable — Notifications for appointment enquiry ## Other responses - `422` — Validation Error ## Changes - **2026-08-20** `686433cd5a70` — 2 info - added the optional property `integration_use_case/config/anyOf[subschema #1]/oneOf[subschema #12: Web Scheduling Use Case Configuration]/insurance_flow_settings/anyOf[subschema #1: IntegrationInsuranceFlowSettings]/skip_card_upload` to the response with the `200` status - added the optional property `integration_use_case/config/anyOf[subschema #1]/oneOf[subschema #6: Appointment Scheduling Use Case Configuration]/insurance_flow_settings/anyOf[subschema #1: IntegrationInsuranceFlowSettings]/skip_card_upload` to the response with the `200` status - …earlier changes not shown [Full history](https://skmtc.dev/interactly/apis/interactly-api-4/changes/integrations/v2/use-cases/:integration_use_case_id/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)