Skip to main content
GET
List clinical flags

Authorizations

Authorization
string
header
default:Bearer sandbox_any_token_works
required

The brand's prescriber system (its clinician tool or Beluga), with its own OAuth client separate from the brand server's. Every write carries the individual prescriber in on_behalf_of. Tokens last 1 hour.

Query Parameters

status
enum<string>[]

One or more statuses, comma-separated.

open until a prescriber acknowledges it; acknowledged until resolved. dismissed flags were closed by TeraRx as raised in error and never change risk.

Available options:
open,
acknowledged,
resolved,
dismissed
severity
enum<string>
Available options:
info,
warning,
critical
Example:

"critical"

enrollment_id
string<uuid>
external_patient_id
string

Your own identifier, printable ASCII without spaces.

Required string length: 1 - 128
Pattern: ^[\x21-\x7E]+$
Example:

"brand-pt-48213"

updated_since
string<date-time>

Only flags changed after this time.

limit
integer
default:25

Page size.

Required range: 1 <= x <= 100
cursor
string

The next_cursor from the previous page. Omit it for the first page.

Maximum string length: 512

Response

A page of flags.

data
object[]
required
next_cursor
string | null
required

Pass it back as cursor for the next page. null on the last page.

Example:

"eyJpZCI6IjAxOTBmNWMyIn0"