{
  "opencollection": "1.0.0",
  "info": {
    "name": "API Reference subpackage_auth.subpackage_auth/default subpackage_pre-encounter.subpackage_pre-encounter/appointments.subpackage_pre-encounter/appointments/v1 API",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "subpackage_pre-encounter.subpackage_pre-encounter/appointments.subpackage_pre-encounter/appointments/v1",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Create",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://pre-api.joincandidhealth.com/appointments/v1",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Adds an appointment.  VersionConflictError is returned when the placer_appointment_id is already in use."
        },
        {
          "info": {
            "name": "Get Visits",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://pre-api.joincandidhealth.com/appointments/v1/visits",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "page_token",
                "value": "",
                "type": "query"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query"
              },
              {
                "name": "sort_field",
                "value": "",
                "type": "query",
                "description": "Defaults to appointment.start_time."
              },
              {
                "name": "sort_direction",
                "value": "",
                "type": "query",
                "description": "Defaults to ascending."
              },
              {
                "name": "filters",
                "value": "",
                "type": "query",
                "description": "**Required:** Must include a date filter on appointment.startTimestamp (using gt, lt, or eq operators).\nExample: appointment.startTimestamp|gt|2024-01-01"
              }
            ]
          },
          "docs": "Gets all Visits within a given time range. The return list is ordered by start_time ascending.\n\n**IMPORTANT:** This endpoint requires a date filter on `appointment.startTimestamp` to ensure acceptable query performance.\nWithout date filtering, the query can take 50+ seconds on large datasets due to grouping and aggregation operations.\n\nExample filters:\n- `appointment.startTimestamp|gt|2024-01-01` - appointments after January 1, 2024\n- `appointment.startTimestamp|eq|2024-12-08` - appointments on "
        },
        {
          "info": {
            "name": "Get",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://pre-api.joincandidhealth.com/appointments/v1/:id",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Gets an appointment."
        },
        {
          "info": {
            "name": "Get History",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://pre-api.joincandidhealth.com/appointments/v1/:id/history",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Gets an appointment along with it's full history.  The return list is ordered by version ascending."
        },
        {
          "info": {
            "name": "Update",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://pre-api.joincandidhealth.com/appointments/v1/:id/:version",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              },
              {
                "name": "version",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates an appointment. The path must contain the next version number to prevent race conditions. For example, if the current version of the appointment is n, you will need to send a request to this endpoint with `/{id}/n+1` to update the appointment. Updating historic versions is not supported."
        },
        {
          "info": {
            "name": "Deactivate",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://pre-api.joincandidhealth.com/appointments/v1/:id/:version",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              },
              {
                "name": "version",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Sets an appointment as deactivated.  The path must contain the most recent version to prevent race conditions.  Deactivating historic versions is not supported. Subsequent updates via PUT to the appointment will \"reactivate\" the appointment and set the deactivated flag to false."
        },
        {
          "info": {
            "name": "Scan",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://pre-api.joincandidhealth.com/appointments/v1/updates/scan",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "since",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Scans up to 100 appointment updates.  The since query parameter is inclusive, and the result list is ordered by updatedAt ascending."
        }
      ]
    }
  ],
  "bundled": true
}