GET
/
v1
/
orgs
/
{org_id}
/
workspaces
/
{workspace_id}
/
deployments
/
{deployment_id}
/
cohorts
/
{cohort_id}
Get Cohort
curl --request GET \
  --url https://apps.sarvam.ai/api/scheduling/v1/orgs/{org_id}/workspaces/{workspace_id}/deployments/{deployment_id}/cohorts/{cohort_id} \
  --header 'X-API-Key: <api-key>'
{
  "name": "April Users Batch 1",
  "cohort_id": "coh-x1y2z3",
  "status": "completed",
  "source_type": "file_upload",
  "result": {
    "total_records": 5000,
    "valid_records": 4850,
    "rejected_records": 150
  },
  "created_by": "user@company.com",
  "created_at": "2026-04-01T09:00:00Z",
  "updated_by": null,
  "updated_at": "2026-04-01T09:02:30Z"
}

Authorizations

​
X-API-Key
string
header
required

Path Parameters

​
org_id
string
required
​
workspace_id
string
required
​
deployment_id
string
required
​
cohort_id
string
required

Response

Successful Response

Cohort metadata including processing status and result counts.

​
name
string
required

Name of the cohort

​
cohort_id
string
required

Unique identifier for the cohort

Example:

"coh-x1y2z3"

​
status
enum<string>
required

Current processing 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 cohort

Example:

"user@company.com"

​
created_at
string<date-time>
required

Timestamp when created (ISO 8601)

Example:

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

​
updated_at
string<date-time>
required

Timestamp when last updated (ISO 8601)

Example:

"2026-04-01T09:02:30Z"

​
result
CohortResult · object

Processing result with record counts

​
updated_by
string | null

User who last updated this cohort