Skip to main content
GET
Get a cohort

Authorizations

X-Api-Key
string
header
required

API key issued for programmatic access.

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
updatedAt
string<date-time>