GET
/
v1
/
orgs
/
{org_id}
/
workspaces
/
{workspace_id}
/
campaigns
/
{campaign_id}
/
cohorts
/
{cohort_id}
Get Cohort
curl --request GET \
  --url https://apps.sarvam.ai/api/scheduling/v1/orgs/{org_id}/workspaces/{workspace_id}/campaigns/{campaign_id}/cohorts/{cohort_id} \
  --header 'X-API-Key: <api-key>'
{
  "name": "<string>",
  "cohort_id": "<string>",
  "status": "processing",
  "source_type": "pre_signed_url",
  "created_by": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "result": {
    "total_records": 123,
    "valid_records": 123,
    "rejected_records": 123
  },
  "updated_by": "<string>"
}
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: 
{
  "result": {
    "total_records": 1000,
    "valid_records": 980,
    "rejected_records": 20
  }
}
If rejected_records is greater than 0, download the rejected records file to see which rows failed and why: 
GET /campaigns/{id}/cohorts/{cohort_id}/files?file_type=rejected_records

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

​
cohort_id
string
required

Unique identifier for the cohort

​
status
enum<string>
required

Current status

Available options:
processing,
completed,
failed
​
source_type
enum<string>
required

How the cohort was uploaded

Available options:
pre_signed_url,
file_upload
​
created_by
string
required

User who created this resource

​
created_at
string<date-time>
required

Timestamp when the resource was created (ISO 8601)

​
updated_at
string<date-time>
required

Timestamp when the resource was last updated (ISO 8601)

​
result
CohortResult · object

Processing result with record counts

​
updated_by
string | null

User who last updated this resource