v1

latestOpenAPI 3.0.3MIT2026-07-26104113247.1 KB
Cohorts

List Saved Cohorts

The list endpoint returns all of the cohorts in a given project. The JSON formatted return contains the cohort name, id, count, description, creation date, and visibility for every cohort in the project.

If you're trying to get a list of users in a cohort, you can use the /engage endpoint with the filter_by_cohort parameter. The Query API has a rate limit of 60 queries per hour and a maximum of 5 concurrent queries.

post/cohorts/list

Query parameters

project_idinteger required

Required if using service account to authenticate request.

workspace_idinteger

The id of the workspace if applicable.

Response

Success.

countinteger
is_visibleinteger

0 if not visible. 1 if visible

descriptionstring
createdstring
project_idinteger
idinteger
namestring