Get Use Case Schema

curl --request GET \
  --url https://api-qa.interactly.ai/integrations/v1/use-cases/{use_case}/schema \
  --header 'Authorization: Bearer <token>'

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

GET

integrations

use-cases

{use_case}

schema

Get Use Case Schema

curl --request GET \
  --url https://api-qa.interactly.ai/integrations/v1/use-cases/{use_case}/schema \
  --header 'Authorization: Bearer <token>'

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorization

string

header

required

Retrieve your API Key from Dashboard API Keys Section.

use_case

enum<string>

required

Available options:

NEW_PATIENT_APPOINTMENT_REMINDER,

LAB_REMINDER,

REFERRAL,

FINAL_APPOINTMENT_NOTIFICATION

Successful Response