v1

latestOpenAPI 3.0.32026-07-267015229.9 KB
Objectives

Get Objective

This endpoint returns a single objective by its unique identifier.

get/v2/objectives/{objectives_id}

Path parameters

objectives_idstring required
Example:o12345

The unique identifier of the objective.

Response

Successfully retrieved objective

Example response

{
  "data": {
    "objective_name": "ask_if_new_patient",
    "objective_prompt": "Ask the patient if they are new or have been here before",
    "confirmation_mode": "auto",
    "output_variables": [
      "patient_status"
    ],
    "modality": "verbal",
    "next_conditional_objectives": {
      "new_patient_intake_process": "If the patient has never been to the practice before",
      "existing_patient_intake_process": "If the patient has been to the practice before"
    },
    "next_required_objective": "get_patient_name",
    "callback_url": "https://your-server.com/webhook",
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-15T10:30:00Z"
  }
}