OAuth endpoints

All 37 endpoints an org admin’s OAuth access token can call: the admin’s own conversations, which only OAuth reaches, and every Patient API endpoint. Each links to its full reference page, with parameters, errors, and code samples.

https://api.bloomtext.com/v1

Send the access token as Authorization: Bearer $BLOOMTEXT_ACCESS_TOKEN. The scope column is what the admin must have approved; see Scopes.

Authorization server

Your app gets and manages tokens with these standard OAuth 2.0 URLs. They return OAuth errors, not problem details. See Connect with OAuth.

The admin’s own conversations

OAuth only. These reach the conversations the connected admin is in, and the organization’s staff directory.

Profile

The person who connected your app with OAuth, and the grant itself.

Messages

The connected person’s own messages, in team chats and patient conversations.

Reactions

Emoji reactions on the connected person’s messages.

Conversations

The connected person’s own conversations, team chats and patient conversations.

Participants

Staff and patients in one of the connected person’s conversations.

Users

Staff members of the connected person’s organization.

Patient API

The same endpoints an API key calls. With OAuth, phone numbers are limited to the admin’s teams’ numbers, and messages come from the admin rather than a key.

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.