Sign in

v5

latestOpenAPI 3.1.02026-08-0456189324.9 KB
Use Cases

Get Use Case Schema

Return JSON schemas plus defaults & example payload for a specific use case.

get/integrations/v1/use-cases/{use_case}/schema

Path parameters

use_case'NEW_PATIENT_APPOINTMENT_REMINDER' | 'LAB_REMINDER' | 'REFERRAL' | 'FINAL_APPOINTMENT_NOTIFICATION' required

Response

Successful Response

{"stackTrail":"paths:/integrations/v1/use-cases/{use_case}/schema:get:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}