v1

latestOpenAPI 3.1.02026-07-262210674.8 KB
v2

Retrieve all cohorts

By default this endpoint returns all cohorts belonging to the workspace to which the supplied API key belongs, plus any cohorts inherited from parent workspaces in the organization hierarchy. If the API key has the required access level, it is also possible to return segments belonging to child workspaces below the requesting workspace in the organization hierarchy.

The queries defining the behaviour of the cohorts are not returned from this endpoint. To retrieve the query of a given cohort, use the 'Retrieve individual cohort' endpoint.

get/v2/cohorts

Query parameters

include-child-workspacesboolean

Whether to return cohorts belonging to workspaces below the requesting workspace in the organization hierarchy. Defaults to false if not specified.

Response

List of cohorts in summary form (excluding query)

idstring required
codeinteger required
namestring required
descriptionstring
tagsstring[]
state'Enabled' | 'Disabled' required
workspaceIdstring required
liveAudienceSizeinteger
createdAtstring date-time required
lastUpdatedAtstring date-time required