GET
Get Cohort
Returns the metadata and processing result for a specific cohort. Poll this endpoint after uploading a cohort to track its status. Once status transitions from processing to completed or failed, the result field is populated with record counts:
If rejected_records is greater than 0, download the rejected records file to see which rows failed and why:

Authorizations

X-API-Key
string
header
required

Path Parameters

org_id
string
required
workspace_id
string
required
campaign_id
string
required
cohort_id
string
required

Response

Successful Response

Cohort metadata including processing status and result counts.

name
string
required

Name of the resource

Example:

"April Batch 1"

cohort_id
string
required

Unique identifier for the cohort

Example:

"coh-x1y2z3"

status
enum<string>
required

Current status

Available options:
processing,
completed,
failed
Example:

"completed"

source_type
enum<string>
required

How the cohort was uploaded

Available options:
pre_signed_url,
file_upload
Example:

"file_upload"

created_by
string
required

User who created this resource

Example:

"user@company.com"

created_at
string<date-time>
required

Timestamp when the resource was created (ISO 8601)

Example:

"2026-04-01T09:00:00Z"

updated_at
string<date-time>
required

Timestamp when the resource was last updated (ISO 8601)

Example:

"2026-04-01T09:05:00Z"

result
CohortResult · object | null

Processing result with record counts

Example:
updated_by
string | null

User who last updated this resource

Example:

"user@example.com"