> ## Documentation Index
> Fetch the complete documentation index at: https://openloop.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# API status at a glance

> Which /v0.1 endpoints work as documented, which differ, and how order status arrives as webhook events, checked against staging.

Use this page to check whether an endpoint behaves the way the API reference describes,
before you build on it. Every **Works** and **Differs** row was executed against staging.

> [!NOTE]
>
> **Every Works and Differs row was executed against staging** with a partner sandbox credential —
> every single-resource read, and the full patient journey including writes. The **By arrangement** row is the prescription webhook feed,
> which no partner call can exercise. The complete list of published operations (109) is at the end
> of this page.

## Legend

| Marker | Meaning |
| - | - |
| **Works** | Behaves as the reference describes |
| **Differs** | Usable, but the reference is wrong or incomplete — read the note before coding |
| **Blocked** | Correct request, blocked by environment configuration |
| **Not partner-facing** | Route exists but expects internal signed credentials. No scope change will help |
| **Published** | In the reference and not exercised by these checks. Build on it, and verify on staging first |
| **No such route** | Not in the published reference under any method. Do not call it; use the route named in the note |
| **By arrangement** | Not an endpoint you call. OpenLoop sets it up for your tenant through your implementation contact |

## The journey at a glance

One row per call in the order you build them. The verdicts are the same ones used in the stage tables below; this table exists so the whole journey fits one screen in either theme.

| # | Call | Verdict | What to know |
| - | - | - | - |
| 1 | `POST /v0.1/patients` | **Works** | `phone` must be E.164; misnamed fields are dropped silently |
| 2 | `GET /v0.1/questionnaires?status=active` | **Works** | Select by `status` and title; hold the id per program in your configuration |
| 3 | `POST /v0.1/questionnaire-responses` | **Differs** | Accepted with `201` whether or not the answers fit the form — validate on your side |
| — | Encounter created for you | **Works** | Created from the completed intake and returned as `encounter_id` (verified on staging 2026-10-05). The encounter itself is not readable |
| 4 | `POST /v0.1/checkouts/sessions` | **Works** | Takes `provider_price_id`, not the price `id`; `type` must match the price interval |
| 5 | Order created from the prescription | **Platform-side** | There is no partner order-create and no order read |
| 6 | Prescription webhook events | **By arrangement** | Four signed events — `prescription.created`, `prescription.ordered`, `prescription.shipped`, `prescription.cancelled` — POSTed to an HTTPS endpoint your implementation contact registers. Signature and delivery are the standard webhook contract (see *Events*). See *Prescription events* |

## Stage 1–3 · Patient and intake

| Endpoint | Status | What to know |
| - | - | - |
| `POST /v0.1/patients` | **Works** | `phone` must be E.164 (`+13125550142`). Field names are `phone` and `birth_date`; misnamed fields are dropped silently |
| `GET /v0.1/patients` | **Works** | `?name=` filters. `?email=` and `?active=` validate their input |
| `GET /v0.1/questionnaires` | **Works** | Filter `?status=active`. Select by `status`, never by list position. Items carry `enable_when` and `enable_behavior` when the form has conditional questions — see *Questionnaire workflow* |
| `PUT /v0.1/patients/{id}` | **Works** | Updates a patient. Partners do not delete records |
| `POST /v0.1/questionnaire-responses` | **Differs** | Works, and returns `encounter_id`. See the validation warning below — this endpoint accepts a great deal it should not |

> [!WARNING]
>
> **`POST /v0.1/questionnaire-responses` performs almost no validation. Validate on your side.**
> Each of the following returns `201`:
>
> * `subject` pointing at a **patient id that does not exist** — and an encounter was created for it
> * a **`questionnaire_id` that does not exist**
> * an **`encounter_id` belonging to a different patient** — the response was attached to it
> * **omitting an answer the questionnaire marks `required: true`**
> * an **answer keyed to a `link_id` the questionnaire does not contain**
>
> Also: `status: "in-progress"`, or omitting `subject`, returns `201` and silently creates **no
> encounter**. Since `subject` is not in the reference's `required` list, a strictly conformant
> client can produce orphaned intakes without ever seeing an error.
>
> Treat a `201` here as "accepted", not "correct". Verify ids before you send them, and read the
> response back.

## Stage 4–6 · Commerce and order status

| Endpoint | Status | What to know |
| - | - | - |
| `GET /v0.1/products` | **Works** | `?active=true` → active only. Any *other* value of `active` is treated as `false` |
| `GET /v0.1/products/{id}/prices` | **Works** | Use `provider_price_id` for checkout, **not** the price `id` |
| `GET /v0.1/prices/{price_id}` | **Works** | Reads one price directly. A product's `current_price_id` can be passed straight here — no lookup step needed |
| `POST /v0.1/checkouts/sessions` | **Works** | `customer_data` needs `email` **and** `name`; items need `provider_price_id`, not `price_id`. Archived products carry prices from a previous payment account and fail with `No such price` — prefer `?active=true` |
| `GET /v0.1/checkouts/sessions/{id}` | **No such route** | The reference documents only `POST /v0.1/checkouts/sessions`. Keep the id and URL from the create response |
| Prescription webhook events | **By arrangement** | Order status (`data.status`) and tracking (`data.tracking_ref` / `data.carrier`) arrive on each event. Payment state is **not** on these events — read it from the billing events or `GET /v0.1/subscriptions` / `GET /v0.1/invoices` (see *Payments and checkout*). Events identify the patient by `data.emr_patient_id`, the patient's `/v0.1` id, the `id` that `GET /v0.1/patients/{id}` takes, whenever the id is known; it is omitted otherwise, never `null`. Without it, only `data.patient_ref` is left, an opaque reference that is not guaranteed to be the `/v0.1` patient id, and how a tenant correlates that is agreed when the endpoint is registered. See *Order status and tracking* |
| `GET /v0.1/configs` | **Works** | Your payment configuration. Check this first when checkout misbehaves |
| `GET /v0.1/payment-methods` | **Varies by tenant** | A `403` naming a payment-provider permission is a configuration gap to report with the `request_id`. It does **not** block checkout |
| `GET /v0.1/prices` (collection) | **No such route** | There is no partner `/prices` collection. Read prices with `GET /v0.1/products/{product_id}/prices` or `GET /v0.1/prices/{price_id}` |

## Clinical data

| Endpoint | Status | What to know |
| - | - | - |
| `GET /v0.1/allergy-intolerances` | **Works** — `?patient_id=`, `?clinical_status=` filter | **Free-text**, not enumerated |
| `GET /v0.1/observations` | **Works** — `?subject_id=`, `?category=`, `?code=` filter | |
| `GET /v0.1/medication-statements` | **Works** | |
| `GET /v0.1/document-references` | **Works** — `?subject_id=` filters | Plus `/content`. Partners do not delete records |
| `GET /v0.1/appointments`, `/appointment-types` | **Works** | |
| `GET /v0.1/slots` | **Differs** | Requires query parameters; `400` without them |
| `GET /v0.1/consents`, `/tasks`, `/sites` | **Works** | Endpoint works; whether records exist depends on your tenant. Partners do not delete records |

Record counts differ per tenant and are not shown here — see *Known gaps and staging* for how to
check your own.

## Two cross-cutting behaviours to design around

**1. Unknown query parameters are handled inconsistently.** Some endpoints reject an unrecognised
parameter with `400`; others accept it, ignore it, and return the unfiltered collection with `200`.
The ones that ignore it include `products`, `appointments`, `appointment-types`, `configs`,
`coupons`, `promotion-codes` and `billing-portals`.
**A `200` does not confirm your filter was understood** — verify the result looks filtered,
especially before concluding a collection is empty or complete.

**2. Response envelopes differ by endpoint.** Three shapes are in use: `{items, after?, request_id}`
for clinical collections (`after` only when there is a next page);
`{items, pagination, request_id}` for the product catalogue; and `{data, request_id}` for single
reads and writes. Do not write one shared pagination helper for the whole API. The product
catalogue carries a `pagination` object, but catalogue paging is not implemented yet, so do not build a cursor loop on it. The
reference also declares a top-level `after` for products; do not page on that either. It is not yet
confirmed that one response always holds the whole catalogue: if products you expect are missing,
send your OLH implementation contact the `request_id`.

## Not part of the partner surface

**Routes that are not in the published reference are not for partners.** A probe of one may draw a
`403`, a `404` or even a `200`; none of those makes it yours. Build only against what the reference
documents, and treat anything else you find on the host as internal and liable to change without
notice.

A `403` complaining about the `Authorization` header rather than about scopes almost always means
the **method** is not mapped on that path — check the reference for the correct verb before
concluding an endpoint is closed to you. There is no partner `/prices` collection; read prices with
`GET /v0.1/products/{product_id}/prices` or `GET /v0.1/prices/{price_id}`.

Partners do not delete patients, questionnaire responses, consents or document references. Test
data you create on staging is cleaned up by OpenLoop; ask your implementation contact.

> [!NOTE]
>
> There is no partner call that lists programs. Program membership is visible on products
> (`program_code`) instead — and note there is currently **no way to look up a program's intake
> questionnaire through the API**. See *Programs and identifiers*.

## Published operations

All 109 operations in the published reference, under `/v0.1`, grouped
by resource. Each is **published**; the tables above say which have been exercised on staging and
how they behave. Anything not listed here is not available to partners.

| Resource | Operations | Count |
| - | - | - |
| `/allergy-intolerances` | `GET /allergy-intolerances` · `POST /allergy-intolerances` · `GET /allergy-intolerances/{id}` · `PUT /allergy-intolerances/{id}` | 4 |
| `/appointment-types` | `GET /appointment-types` · `GET /appointment-types/{id}` | 2 |
| `/appointments` | `GET /appointments` · `POST /appointments` · `GET /appointments/{id}` · `PATCH /appointments/{id}` | 4 |
| `/auth` | `POST /auth/register` · `POST /auth/revoke` · `POST /auth/send-otp` · `POST /auth/token` · `POST /auth/verify-otp` | 5 |
| `/benefit-coordinations` | `POST /benefit-coordinations` | 1 |
| `/billing-customers` | `GET /billing-customers` · `POST /billing-customers` · `GET /billing-customers/{provider_customer_id}` · `PUT /billing-customers/{provider_customer_id}` · `GET /billing-customers/{provider_customer_id}/subscriptions` · `GET /billing-customers/{provider_customer_id}/balance-transactions` · `POST /billing-customers/{provider_customer_id}/balance-transactions` | 7 |
| `/billing-portals` | `GET /billing-portals` · `POST /billing-portals/retention-sessions` · `POST /billing-portals/{provider_billing_portal_id}/sessions` | 3 |
| `/checkouts` | `POST /checkouts/sessions` | 1 |
| `/configs` | `GET /configs` | 1 |
| `/consents` | `GET /consents` · `POST /consents` · `GET /consents/{id}` · `PUT /consents/{id}` | 4 |
| `/coupons` | `GET /coupons` · `POST /coupons` · `GET /coupons/{provider_coupon_id}` · `DELETE /coupons/{provider_coupon_id}` | 4 |
| `/document-references` | `GET /document-references` · `POST /document-references` · `POST /document-references/content` · `GET /document-references/{id}` · `PUT /document-references/{id}` · `GET /document-references/{id}/content` | 6 |
| `/eligibility-verifications` | `POST /eligibility-verifications` · `GET /eligibility-verifications/{id}` | 2 |
| `/iam/users` | `GET /iam/users/find` · `GET /iam/users/links` · `DELETE /iam/users/me` | 3 |
| `/insurance-discoveries` | `POST /insurance-discoveries` · `GET /insurance-discoveries/{id}` | 2 |
| `/intents/payments` | `GET /intents/payments/{provider_payment_intent_id}` | 1 |
| `/intents/setups` | `POST /intents/setups` · `GET /intents/setups/{provider_setup_intent_id}` | 2 |
| `/invoices` | `GET /invoices` · `POST /invoices/previews` · `POST /invoices/{provider_invoice_id}/payments` · `POST /invoices/{provider_invoice_id}/refunds` | 4 |
| `/laboratories` | `POST /laboratories` | 1 |
| `/medicare-id-lookups` | `POST /medicare-id-lookups` | 1 |
| `/medication-statements` | `GET /medication-statements` · `POST /medication-statements` · `GET /medication-statements/{id}` | 3 |
| `/network-status` | `POST /network-status` | 1 |
| `/observations` | `GET /observations` · `POST /observations` · `GET /observations/{id}` | 3 |
| `/organizations` | `GET /organizations/{id}` | 1 |
| `/patients` | `GET /patients` · `POST /patients` · `GET /patients/{id}` · `PUT /patients/{id}` | 4 |
| `/payment-methods` | `GET /payment-methods` | 1 |
| `/prices` | `GET /prices/{price_id}` | 1 |
| `/products` | `GET /products` · `GET /products/{product_id}` · `GET /products/{product_id}/prices` | 3 |
| `/promotion-codes` | `GET /promotion-codes` · `POST /promotion-codes` · `DELETE /promotion-codes/{provider_promotion_code_id}` | 3 |
| `/questionnaire-responses` | `GET /questionnaire-responses` · `POST /questionnaire-responses` · `GET /questionnaire-responses/{id}` · `PUT /questionnaire-responses/{id}` | 4 |
| `/questionnaires` | `GET /questionnaires` · `GET /questionnaires/{id}` | 2 |
| `/related-persons` | `GET /related-persons` · `POST /related-persons` · `GET /related-persons/{id}` · `PUT /related-persons/{id}` | 4 |
| `/reservations` | `POST /reservations` · `DELETE /reservations/{id}` | 2 |
| `/sites` | `GET /sites` · `POST /sites` · `GET /sites/{key}` · `PATCH /sites/{key}` · `DELETE /sites/{key}` | 5 |
| `/slots` | `GET /slots` | 1 |
| `/subscriptions` | `GET /subscriptions` · `POST /subscriptions` · `GET /subscriptions/{provider_subscription_id}` · `PUT /subscriptions/{provider_subscription_id}` · `DELETE /subscriptions/{provider_subscription_id}` · `GET /subscriptions/{provider_subscription_id}/invoices` · `POST /subscriptions/{provider_subscription_id}/pauses` · `DELETE /subscriptions/{provider_subscription_id}/pauses` | 8 |
| `/tasks` | `GET /tasks` · `POST /tasks` · `GET /tasks/{id}` · `PUT /tasks/{id}` · `DELETE /tasks/{id}` | 5 |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.