Patient API endpoints

All 26 Patient API endpoints an API key can call, grouped by resource. 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. A key that reaches more than one organization names one with org_id on every call; see Organizations a key reaches. Anything under /me or /users needs OAuth, which BloomText turns on per account; an API key gets 403 with code: oauth_required. See OAuth endpoints. An account key also calls the account endpoints.

Organization

The organization an API key acts on.

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.