GET
/
v1
/
orgs
/
{org_id}
/
workspaces
/
{workspace_id}
/
deployments
/
{deployment_id}
/
cohorts
List Cohorts
curl --request GET \
  --url https://apps.sarvam.ai/api/scheduling/v1/orgs/{org_id}/workspaces/{workspace_id}/deployments/{deployment_id}/cohorts \
  --header 'X-API-Key: <api-key>'
{
  "items": [
    {
      "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"
    }
  ],
  "total": 1,
  "limit": 10,
  "offset": 0,
  "next_page_uri": null,
  "prev_page_uri": null
}

Authorizations

​
X-API-Key
string
header
required

Path Parameters

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

Query Parameters

​
offset
integer
default:0

Number of records to skip

Required range: x >= 0
​
limit
integer
default:10

Number of records to return (max 100)

Required range: 1 <= x <= 100
​
sort_by
string | null

Field to sort by

​
sort_order
string | null

Sort order (asc or desc)

​
search
string | null

Search query string

Response

Successful Response

Paginated list of cohorts.

​
items
CohortMetadata · object[]
required

List of cohorts on this page

​
total
integer
required

Total number of cohorts matching the query

​
limit
integer
required

Maximum number of items per page

​
offset
integer
required

Number of items skipped

​
next_page_uri
string | null

URI to fetch the next page, or null if this is the last page

​
prev_page_uri
string | null

URI to fetch the previous page, or null if this is the last page