List patient conversations

GET/patient-conversations

Lists patient conversations with messages in a time range, most recently active first, each with its latest message and how many messages fell in the range. Filter to one patient with patient_id. Every request passes after or patient_id, so a read is always bounded; there’s no search by patient name.

Credentials: API key, or an OAuth access token
Scope: messages.read

Run in Postman: import the collection, set api_key, and find this request in its folder.

Query parameters

org_idUUID

The organization the call acts on, from List organizations. Required when an account API key reaches more than one organization; an organization key or a key limited to one organization can leave it out.

afterstring

Only messages sent at or after this time. An RFC 3339 timestamp, or a date for midnight in the organization’s time zone.

beforestring

Only messages sent before this time. Same format as after.

patient_idUUID

Only conversations with this patient, on any phone number.

page[limit]integer

Number of records to return. Defaults to 50, maximum 100.

page[after]string

Cursor from the previous page’s pagination.next_cursor.

Returns

Returns 200 OK with a data array of Conversation objects and a pagination object. See pagination.

Errors

Failed requests return application/problem+json problem details. The errors specific to this endpoint:

Status	Code	Meaning
400	`invalid_request`	The request is malformed, such as invalid JSON.
400	`org_id_required`	The key reaches more than one organization: pass `org_id`.
400	`range_required`	Pass `after` or `patient_id`, so every read is bounded.
401	`invalid_token`	The API key is missing or malformed, or isn’t a BloomText key.
401	`key_revoked`	The API key was revoked.
401	`key_expired`	The API key’s expiry has passed.
403	`insufficient_scope`	The key doesn’t have the scope this endpoint needs.
403	`org_not_reachable`	The key can’t reach the organization in `org_id`.
429	`rate_limited`	Too many requests. Retry after `Retry-After` seconds.

cURL

Request


curl "https://api.bloomtext.com/v1/patient-conversations?after=2026-09-21T00:00:00Z" \
  -H "Authorization: Bearer $BLOOMTEXT_API_KEY"

JavaScript

Request


const response = await fetch('https://api.bloomtext.com/v1/patient-conversations?after=2026-09-21T00:00:00Z', {
  headers: {
    Authorization: `Bearer ${process.env.BLOOMTEXT_API_KEY}`,
  },
})
 
if (!response.ok) throw new Error(`BloomText API error: ${response.status}`)
const data = await response.json()

Python

Request


import os
 
import requests
 
response = requests.get(
    "https://api.bloomtext.com/v1/patient-conversations?after=2026-09-21T00:00:00Z",
    headers={
        "Authorization": f"Bearer {os.environ['BLOOMTEXT_API_KEY']}",
    },
)
response.raise_for_status()
data = response.json()

Go

Request


package main
 
import (
	"fmt"
	"io"
	"net/http"
	"os"
)
 
func main() {
	req, err := http.NewRequest("GET", "https://api.bloomtext.com/v1/patient-conversations?after=2026-09-21T00:00:00Z", nil)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer "+os.Getenv("BLOOMTEXT_API_KEY"))
 
	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()
 
	out, _ := io.ReadAll(res.Body)
	fmt.Println(res.Status, string(out))
}

Ruby

Request


require "net/http"
require "json"
 
uri = URI("https://api.bloomtext.com/v1/patient-conversations?after=2026-09-21T00:00:00Z")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer #{ENV.fetch("BLOOMTEXT_API_KEY")}"
 
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
  http.request(request)
end
data = JSON.parse(response.body)

Response · 200 OK


{
  "data": [
    {
      "id": "e5c3b7b8-8f08-4d5a-9af1-0d11b0f4b7a0",
      "organization_id": "6db1e3f5-9b7f-4f2b-8be1-0f1e1d7d7d8c",
      "type": "patient",
      "title": "Jane Doe",
      "patient": {
        "id": "5a1c9e2b-7d44-4f1a-9c3e-2b8d6f0a1e77",
        "name": "Jane Doe"
      },
      "phone_number": {
        "number": "+15125550100",
        "team": "Front desk"
      },
      "channel": "sms",
      "created_at": "2026-09-21T15:04:05Z",
      "last_message_at": "2026-09-21T15:04:05Z",
      "unread_count": 0,
      "seen_at": null,
      "messages_in_range": null,
      "latest_message": null
    }
  ],
  "pagination": {
    "next_cursor": null,
    "has_more": false
  }
}