Skip to Content
API access is available to organizations with a signed BAA. Request API access →
Introduction

BloomText API

The BloomText API brings your BloomText account into your own software: text patients and read their replies, keep patient records in step with your EHR, and keep staff, organizations and teams in step with your HR or identity system. An account’s Owners and IT create API keys and choose the organizations each one reaches.

API key · for your server

Patient API

Text patients by phone number or patient ID, keep patient records in step with your EHR, and read what patients wrote back. No person signs in.

Start the Patient API quickstart →
API key · for IT and HR systems

Staff and organizations

Add, change and remove staff and their teams across your account’s organizations from your HR or identity system, alongside Okta single sign-on and Directory Sync.

Manage members →
A person’s account · admins for now

OAuth

Let a person connect their BloomText account to your app, then work in their own conversations, team chats and patient conversations alike.

Start the OAuth quickstart →

Every path starts with an API key an account Owner or IT person creates. See Authentication for scopes and limits.

What you can build

Patient APIPatient messaging from your EHRText a patient from their chart with one request. BloomText finds or creates the patient and the conversation.Patient APIPatient syncKeep BloomText’s patients in step with your system, matched by MRN, phone, or email.Staff and organizationsStaff provisioningAdd new hires to the right organizations and teams, change roles, and remove people who leave, from your HR system.Staff and organizationsSeparate clinics or officesRun each as its own organization on one account, with keys limited to the ones each system serves.Staff and organizationsYour own reporting and auditsDelivery status and membership changes from the API, and account-wide exports for Owners and IT.Patient APIReal-time repliesGet a signed request the moment a patient writes in or a text is delivered, instead of polling.

How it works

Your server texts a patient and reads the reply with an API key. No one signs in.

  1. BloomText turns on API access for your account, and an Owner or IT person creates an API key under Settings → Account → API keys, choosing its scopes and the organizations it reaches.
  2. Your server messages patients, manages patient records, and keeps staff and teams in step with your HR or identity system.
  3. If your staff sign in with Okta, SSO and Directory Sync can manage people instead, and the API sees who manages each membership.

The OpenAPI spec

Every endpoint is described in an OpenAPI spec you can download, feed to a client generator, or import into tools like Okta Workflows and Postman. The API reference is generated from it.

Download the OpenAPI specVersion 1.0.0
Run in PostmanDownloads the BloomText collection, generated from the spec. In Postman, choose Import and drop in the file, or paste this link, then set the api_key variable. If your key reaches several organizations, set org_id and switch on that parameter.

Turned on when you ask

Some features are turned on per account when you ask. They’re documented in full, and each page has a Request access button that books a call: webhooks, API identities, phone-number limits on keys, campaigns, patient imports, the audit events API, and OAuth. Everything else on these pages works today.

Access

API access requires a signed BAA. Request API access to get started, and see Security and BAA for how the API protects patient data.

Don’t include patient information in your access request. The form isn’t a secure channel.

Last updated on
Core concepts