API reference

Base URL

Paths in this reference are relative to the API's base URL, which includes /api.

Every request sends your API key as Authorization: Bearer nzh_sb_…. See Authentication for keys, environments, 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

1. 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.
2. Postman sets the collection's baseUrl variable from the file's first server, the sandbox. Change it under the collection's Variables to call another environment.
3. On the collection's Authorization tab, make sure Bearer Token is chosen and paste your sandbox key (nzh_sb_…) as the token, without the word Bearer. Postman sends it as the Authorization header on every request.
4. Send Submit a patient lifecycle event with a new eventId to check the key works.

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

• Patient lifecycleEnroll, update and cancel patients.
• Clinical casesReport progress, message the patient, resolve.
• ConversationsRead and send messages in a case's thread.
• Webhook eventsWhat NezerCare sends to your endpoints.
• Workflow setupThe staff app's workflow endpoints.