Skip to main content
GET
Get a cohort

Path Parameters

cohortId
string
required
Pattern: ^[0-9A-HJ-KM-NP-TV-Z]{13}$

Response

the cohort

cohortId
string
required
Pattern: ^[0-9A-HJ-KM-NP-TV-Z]{13}$
numWallets
integer<int64>
required
status
enum<string>
required

Membership is only complete once this reads ready; numWallets is 0 until then.

Available options:
pending,
building,
ready,
canceled,
failed
title
string
required
createdAt
string<date-time>
description
string
groups
Criteria group · object[]

The criteria defining the cohort, in the shape create and update accept, so it can be read, edited and sent back. Absent for a cohort built from a wallet list, and for one whose stored definition names something this API cannot express — condition values are always returned as strings, since a measure can exceed the range of a JSON number.

Minimum array length: 1
match
enum<string>

How the members combine. Required when there is more than one.

Available options:
AND,
OR
updatedAt
string<date-time>