API reference
API reference
Every endpoint, field and event in the NezerCare Integration API, from the same OpenAPI contract you can download.
Base URL
Paths in this reference, such as /v1/clinical-cases/{caseId}/progress, are relative to the base URL below. The paths that clinical_case.opened carries in data.handoff are the API's own and start with /api/v1/…: leave that /api off when you call them.
| Server | Base URL |
|---|---|
| NezerCare | https://api.nezercare.com |
Every request but the staff app's workflow setup calls (which take a team member's sign-in, not an API key) sends your API key as Authorization: Bearer nzh_prod_…. See Authentication for keys, idempotency and errors.
OpenAPI file
The reference is built from one OpenAPI 3.1 file. Download it to generate a client, check a request in your tests, or import it into an API tool.
Download nezercare-openapi.json
Test in Postman
- In Postman, choose Import and select the downloaded file (or paste its address,
https://<this site>/api/developers/openapi). Postman makes a collection with every endpoint and its example bodies. - Postman sets the collection's
baseUrlvariable from the file's first server, NezerCare's API. Change it under the collection's Variables to call a local development server. - On the collection's Authorization tab, make sure Bearer Token is chosen and paste your API key (
nzh_prod_…) as the token, without the wordBearer. Postman sends it as theAuthorizationheader on every request. - Send Read current external-care progress with any made-up case ID (a UUID) to check the key works:
404means the key was accepted and the case isn't in your workspace,401means the key is wrong, and403means the BAA isn't signed yet (BAA_REQUIRED) or the key wasn't made for case updates (INSUFFICIENT_SCOPE). Calls reach your organization's real workspace, so act only on your own test cases.
Keep keys out of shared workspaces
Store the key in a Postman environment that only you can see, not in a shared collection. Rotate any key that ends up in chat, logs or source control.
Prefer the command line? Every endpoint on the following pages has a cURL example, like this one:
curl "https://api.nezercare.com/v1/clinical-cases/CASE_ID/progress" \
--header "Authorization: Bearer $NEZER_API_KEY"Sections
- Clinical casesReport progress, message the patient, resolve.
- ConversationsRead and send messages in a case's thread.
- Patient messagingIdentify patients and exchange their messages from your own portal.
- Webhook eventsWhat NezerCare sends to your endpoints.
- Workflow setupThe staff app's workflow endpoints.