Skip to main content
GET
/
integrations
/
v2
/
use-cases
List Integrations
curl --request GET \
  --url https://api-qa.interactly.ai/integrations/v2/use-cases \
  --header 'Authorization: Bearer <token>'
{
  "integration_use_cases": [
    {
      "teamId": "5eb7cf5a86d9755df3a6c593",
      "createdBy": "5eb7cf5a86d9755df3a6c593",
      "updatedBy": "5eb7cf5a86d9755df3a6c593",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "_id": "5eb7cf5a86d9755df3a6c593",
      "logicalId": "<string>",
      "integrationId": "5eb7cf5a86d9755df3a6c593",
      "config": {
        "displayName": "<string>",
        "assistantId": "5eb7cf5a86d9755df3a6c593",
        "status": "active",
        "timezone": "<string>",
        "type": "appointment_reminder_with_sheet",
        "name": "New Patients Appointment Reminder",
        "sheetLink": "<string>",
        "actions": [
          {
            "templateName": "<string>",
            "actionType": "call",
            "context": "<string>",
            "schedule": {
              "startDateTime": "2023-11-07T05:31:56Z",
              "endDateTime": "2023-11-07T05:31:56Z",
              "field": "oneTime",
              "triggerAt": "2023-11-07T05:31:56Z"
            }
          }
        ]
      }
    }
  ],
  "total": 123
}

Authorizations

Authorization
string
header
required

Retrieve your API Key from Dashboard API Keys Section.

Query Parameters

filters
IntegrationsUseCasesFilters · object
required
size
integer
default:100

Number of items per page

Required range: x >= 1
page
integer
default:1

Page number

Required range: x >= 1
search
string | null

Search keywords

start
string<date-time> | null

Filter by start time (ISO 8601 format)

end
string<date-time> | null

Filter by end time (ISO 8601 format)

Response

Successful Response

Response model for a list of integrations use cases. Contains a list of IntegrationsUseCasesModel objects.

integration_use_cases
IntegrationsUseCasesModel · object[]

List of integrations use cases

total
integer | null

Total number of integrations use cases available without pagination.