INinteractly
Integrations Use Cases V2

List Integrations

Changed on
get/integrations/v2/use-cases

Request

  • Base URL
    https://api-qa.interactly.ai
  • URL
    https://api-qa.interactly.ai/integrations/v2/use-cases
  • Auth
    HTTP bearer

Query parameters

integrationIdstring nullable

Reference to the associated integration

status'active' | 'inactive'

Represents whether the integration is active or inactive.

type'appointment_reminder_with_sheet' | 'lab_reminder_with_sheet' | 'appointment_reminder' | 'final_appointment_notification' | 'lab_reminder' | 'appointment_scheduling' | 'appointment_cancellation' | 'appointment_rescheduling' | 'appointment_scheduling_with_waitlist' | 'medication_refill' | 'invoice_enquiry' | 'web_scheduling' | 'insurance_reminder' | 'appointment_enquiry' | 'patient_forms'

Defines the type of use-case for an integration.

{
  "integrationId": "5eb7cf5a86d9755df3a6c593"
}
sizeinteger

Number of items per page

pageinteger

Page number

searchstring nullable

Search keywords

startstring date-time nullable

Filter by start time (ISO 8601 format)

endstring date-time nullable

Filter by end time (ISO 8601 format)

Response

Successful Response

totalinteger nullable

Total number of integrations use cases available without pagination.

Example response

{
  "integration": {
    "teamId": "5eb7cf5a86d9755df3a6c593",
    "createdBy": "5eb7cf5a86d9755df3a6c593",
    "updatedBy": "5eb7cf5a86d9755df3a6c593",
    "_id": "5eb7cf5a86d9755df3a6c593",
    "flowTemplate": {
      "schedulingCapacityRule": {
        "perTypeRules": [
          {
            "appointmentType": "5eb7cf5a86d9755df3a6c593",
            "excludedWithTypes": [
              "5eb7cf5a86d9755df3a6c593"
            ]
          }
        ],
        "adjacencyRules": [
          {
            "typeA": "5eb7cf5a86d9755df3a6c593",
            "typeB": "5eb7cf5a86d9755df3a6c593"
          }
        ]
      }
    }
  },
  "integration_use_cases": [
    {
      "teamId": "5eb7cf5a86d9755df3a6c593",
      "createdBy": "5eb7cf5a86d9755df3a6c593",
      "updatedBy": "5eb7cf5a86d9755df3a6c593",
      "_id": "5eb7cf5a86d9755df3a6c593",
      "integrationId": "5eb7cf5a86d9755df3a6c593",
      "config": {
        "assistantId": "5eb7cf5a86d9755df3a6c593"
      }
    }
  ]
}

Changes

  • ea12369d8e0eRevision changes
    • info

      removed the direct_athena enum value from the ///// response property for the response status

    • info

      removed the direct_athena enum value from the ///// response property for the response status

    • info

      removed the ellkay enum value from the ///// response property for the response status

    • info

      removed the ellkay enum value from the ///// response property for the response status

  • 2c0bdb27b07dRevision changes
    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      the response's property default value changed from xcaliber_health to interactly_ehr_gateway for the status

    • info

      the response's property default value changed from xcaliber_health to interactly_ehr_gateway for the status