Sign in
Integrations Use Cases V2

List Integrations

get/integrations/v2/use-cases

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'

Defines the type of use-case for an integration.

{
  "integrationId": "5eb7cf5a86d9755df3a6c593"
}
sizeinteger

Number of items per page

Number of items per page

pageinteger

Page number

Page number

searchstring nullable

Search keywords

Search keywords

startstring date-time nullable

Filter by start time (ISO 8601 format)

Filter by start time (ISO 8601 format)

endstring date-time nullable

Filter by end time (ISO 8601 format)

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