Skip to main content
GET
Get Cohort Patients

Headers

TENANT
string
required

The tenant you are making this request on behalf of

API-KEY
string
required

Your api key

Path Parameters

cohort_id
string
required

Query Parameters

page
integer
default:1
Required range: x >= 1
per_page
integer
default:25
Required range: 1 <= x <= 100
channel
enum<string> | null
Available options:
SMS,
EMAIL
is_marketing
boolean
default:false
tz
string | null

Client timezone for day-based filter calculations

Response

Successful Response

data
CohortPatient · object[]
required
total
integer
required