Skip to main content
Written for the engineer doing the integration. Everything here is something you would otherwise discover by hitting it mid-build, so read it once before you start and again if something behaves unexpectedly. This page is only about what is absent or environmental. For how a working endpoint behaves, see API status; for diagnosing a specific error, see FAQ and troubleshooting.

Known gaps

Staging setup

What is reachable. Patients, questionnaires, questionnaire-responses, products, prices, appointments, and configs all return 200 for a sandbox bearer token. Encounters and orders are not on the partner surface. Everything is under /v0.1, including /v0.1/auth/token. /v1 paths are not part of the partner surface — a partner token draws an authorization error on some and an empty result set on others. Verify staging writes through the API, not through care-team tools. A patient or intake you create on staging is proven by its 201 and its read-back. Whether it also appears in the tools your care team uses depends on your tenant’s sync configuration, which may not be connected on staging at all. What is seeded is minimal, and it differs per tenant. Do not calibrate against numbers in this cookbook — run GET /v0.1/questionnaires?limit=100 and GET /v0.1/products?limit=100 and read your own. Tenants we have seen hold a single generic seed questionnaire and a handful of weight-management products. Establish which programs exist for you by collecting the distinct program_code values across your products. There is no “list my programs” call. If your programs are not in that set, nothing relevant to you is seeded — request it, and expect that to be the most common reason a new integration stalls in week one. Empty responses are usually missing seed data, not a broken query. Confirm seeding before debugging your request. A 403 about the Authorization header is usually a wrong-method error. Before concluding an endpoint is closed to you, check the reference for the verb that path accepts: reservations, invoices/previews and checkouts/sessions all work on POST while returning that 403 on a GET. There is no partner /prices collection; read prices with GET /v0.1/products/{product_id}/prices or GET /v0.1/prices/{price_id}. Lab ordering in staging runs against a sandbox lab network with a small cap on patients. Each patient you order for is registered with the lab network on their first order, and the staging sandbox holds a limited number of them. Once it is full, a first order for a new patient fails with a 502 PROVIDER_ERROR that is not caused by your request. If a correct request fails this way on staging, report it with the request_id before changing your integration. Genuinely unavailable to partners: /v0.1/programs and /v0.1/bundles — see the programs note below. Query parameters some list endpoints require. /v0.1/subscriptions and /v0.1/invoices require email. Without them you get a 400 naming the missing parameter.
Developers outside the United States can be blocked by the WAF. Authentication requests from some non-US regions are filtered at the edge before reaching the API, which presents as an auth failure rather than a geo block. If developers on your team are outside the US — or on a non-US VPN — send your OLH implementation contact the blocked request details and the source region so the traffic can be allow-listed. This is a one-time setup step per region and is easy to misdiagnose as a credential problem.

Reporting a problem usefully

Include the request_id from the response envelope, the full path with its version prefix, and the HTTP status. request_id is the fastest way for us to find the call server-side; a description without one usually costs a round trip.