Patient API endpoints

All 25 endpoints an organization API key can call, grouped by resource. An org admin’s OAuth token can call every one of them too, and they behave the same. Each links to its full reference page, with parameters, errors, and code samples.

https://api.bloomtext.com/v1

Send the key as Authorization: Bearer $BLOOMTEXT_API_KEY. The scope column is what the key needs; see Scopes. An API key can’t reach anything under /me or /users, which return 403 with code: oauth_required. See OAuth endpoints for those.

Organization

The organization a credential belongs to.

Patients

Patient records, always found by patient ID, phone number, or MRN.

Patient imports

Bulk imports of patient records.

Patient messages

Messages with patients: send to a patient by ID or phone number, read patient messages by time range, and check delivery.

Patient conversations

Conversations with patients, one per patient and clinic phone number.

Phone numbers

The clinic phone numbers messages to patients come from, and the team each belongs to.

Campaigns

One message sent to many patients from a clinic phone number, with per-patient delivery.