v1

latestOpenAPI 3.0.32026-07-267015229.9 KB
Objectives

Get Objectives

This endpoint returns a list of all objectives.

get/v2/objectives

Query parameters

limitinteger

The number of objectives to return per page. Default is 10.

pageinteger

The page number to return. Default is 1.

Response

Successfully retrieved objectives

total_countinteger

The total number of objectives

Example response

{
  "data": [
    {
      "objectives_id": "o12345",
      "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"
    }
  ],
  "total_count": 25
}