API reference

The BloomText API is a REST API with JSON request and response bodies, standard HTTP status codes, and bearer authentication with an API key or an OAuth 2.0 access token. Everything on these pages is generated from the OpenAPI 3.1 spec, which you can also feed to any client generator.

Base URL


https://api.bloomtext.com/v1

New to the API? Start with the Patient API quickstart or the OAuth quickstart, then read Authentication for API keys, OAuth, and scopes.

Endpoints by credential

All Patient API endpoints All OAuth endpoints

Resources

Organization Patients Patient imports Patient messages Patient conversations Phone numbers Campaigns Profile Messages Reactions Conversations Participants Users

Conventions

Authentication: send an API key or an org admin’s OAuth access token as Authorization: Bearer …. Each page says which it accepts. See Authentication.
Access: API keys reach the Patient API only: patient records by ID, phone, or MRN, and bounded reads of patient messages. OAuth also reaches the connected person’s own conversations under /me.
Search: message lists take a q of words and operators, like refill from:patient. See Search.
IDs: objects have a stable id, usually a UUID.
Timestamps: RFC 3339 strings in UTC, like 2026-09-21T12:00:00Z.
Lists: cursor-paginated with page[limit] and page[after]. See Pagination.
Writes: every POST takes an Idempotency-Key. See Idempotency.
Errors: RFC 9457 problem details. See Errors.

All endpoints

Organization

Method	Path	Endpoint
GET	`/organization`	Retrieve the organization

Patients

Method	Path	Endpoint
GET	`/patients`	Find patients
POST	`/patients`	Create a patient
GET	`/patients/{patientId}`	Retrieve a patient
PATCH	`/patients/{patientId}`	Update a patient
DELETE	`/patients/{patientId}`	Delete a patient

Patient imports

Method	Path	Endpoint
POST	`/patient-imports`	Import patients
GET	`/patient-imports/{importId}`	Retrieve an import

Patient messages

Method	Path	Endpoint
GET	`/patient-messages`	List patient messages
POST	`/patient-messages`	Send a message to a patient
GET	`/patient-messages/{messageId}`	Retrieve a patient message

Patient conversations

Method	Path	Endpoint
GET	`/patient-conversations`	List patient conversations
GET	`/patient-conversations/{conversationId}`	Retrieve a patient conversation

Phone numbers

Method	Path	Endpoint
GET	`/phone-numbers`	List phone numbers

Campaigns

Method	Path	Endpoint
GET	`/campaigns`	List campaigns
POST	`/campaigns`	Create a campaign
GET	`/campaigns/{campaignId}`	Retrieve a campaign
PATCH	`/campaigns/{campaignId}`	Update a campaign
DELETE	`/campaigns/{campaignId}`	Delete a campaign
GET	`/campaigns/{campaignId}/recipients`	List campaign recipients
POST	`/campaigns/{campaignId}/recipients`	Add campaign recipients
POST	`/campaigns/{campaignId}/recipients/remove`	Remove campaign recipients
POST	`/campaigns/{campaignId}/start`	Start a campaign
POST	`/campaigns/{campaignId}/pause`	Pause a campaign
POST	`/campaigns/{campaignId}/stop`	Stop a campaign

Profile

Method	Path	Endpoint
GET	`/me`	Retrieve the profile

Messages

Method	Path	Endpoint
GET	`/me/messages`	List messages
GET	`/me/messages/{messageId}`	Retrieve a message
POST	`/me/conversations/{conversationId}/messages`	Send a message

Reactions

Method	Path	Endpoint
GET	`/me/messages/{messageId}/reactions`	List reactions
POST	`/me/messages/{messageId}/reactions`	Add a reaction
DELETE	`/me/messages/{messageId}/reactions`	Remove a reaction

Conversations

Method	Path	Endpoint
GET	`/me/conversations`	List conversations
GET	`/me/conversations/{conversationId}`	Retrieve a conversation

Participants

Method	Path	Endpoint
GET	`/me/conversations/{conversationId}/participants`	List participants

Users

Method	Path	Endpoint
GET	`/users`	List users
GET	`/users/{userId}`	Retrieve a user