Appearance
Color theme
Appearance
List, retrieve, and search twelve versioned MINT cohort definitions.
export MINT_DOCS_BASE="https://docs.mint.us"
curl --fail --show-error "$MINT_DOCS_BASE/cohorts.json"Returns catalogId, version, scope, and records. Use your running docs address as the base URL. The examples use the published docs address above.
Download the client for your language. No package installation or model call is needed.
curl --fail --show-error "$MINT_DOCS_BASE/cohorts-client.mjs" -o cohorts-client.mjscurl --fail --show-error "$MINT_DOCS_BASE/cohorts_client.py" -o cohorts_client.pySave and run the example beside the downloaded client.
import { loadCohorts, listCohorts, getCohort, searchCohorts } from './cohorts-client.mjs';
const registry = await loadCohorts(process.env.MINT_DOCS_BASE);
console.table(listCohorts(registry));
console.log(getCohort(registry, 'volume-rebates'));
console.log(searchCohorts(registry, 'return'));import os
from cohorts_client import load_cohorts, list_cohorts, get_cohort, search_cohorts
registry = load_cohorts(os.environ["MINT_DOCS_BASE"])
print(list_cohorts(registry))
print(get_cohort(registry, "volume-rebates"))
print(search_cohorts(registry, "return"))node example.mjs
# Or:
python3 example.py| Action | JavaScript | Python | Returns |
|---|---|---|---|
| Load | loadCohorts(baseUrl) | load_cohorts(base_url) | Registry version 0.1.0 |
| List | listCohorts(registry) | list_cohorts(registry) | IDs, names, and asset structures |
| Get | getCohort(registry, id) | get_cohort(registry, id) | One complete record by exact ID |
| Search | searchCohorts(registry, text) | search_cohorts(registry, text) | Matching definitions |
Search covers names, structures, aliases, descriptions, and evidence fields. A returned record retains its version and source references.
| Error code | Meaning |
|---|---|
COHORT_NOT_FOUND | The exact ID is not in the registry. |
QUERY_REQUIRED | Search text is empty. |
INVALID_URL | The docs base URL is invalid. |
FETCH_FAILED | The registry could not be downloaded or parsed. |
INVALID_REGISTRY | The response has an unsupported version or invalid fields. |
JavaScript requires Node.js 18+ or a browser with fetch. Python requires 3.8+. TypeScript declarations are available beside the JavaScript module.
Selected fields from the actual volume-rebates definition:
{
"id": "volume-rebates",
"version": "0.1.0",
"name": "Volume rebates",
"assetStructure": "Net-of-rebate receivable",
"entryRule": null,
"exclusionRule": null,
"amountRule": null,
"releaseRule": null
}The four rule fields are null: definition lookup does not assign assets or establish buyer fit. Reference events are descriptions, not funding decisions. Evidence fields and source hashes remain in the complete record.
Each cohort page includes its exact-ID lookup in JavaScript and Python, complete definition response, evidence requirements, field reference, and schema.
| Stable ID and cohort | Asset structure |
|---|---|
return-window-survivorsReturn-window survivors | Return-resolved receivable |
late-delivery-claimsLate-delivery claims | Penalty-bounded receivable |
partially-fulfilled-posPartially fulfilled purchase orders | Line-item microreceivables |
delivered-awaiting-acceptanceDelivered, awaiting acceptance | Event-vested receivable |
retail-chargebacksRetail chargebacks | Clean base and recovery strip |
volume-rebatesVolume rebates | Net-of-rebate receivable |
promotional-allowancesPromotional allowances | Promotion-normalized claim |
predictable-short-paysPredictable short-pays | Empirically netted receivable |
delivered-not-invoicedDelivered, not yet invoiced | Verified unbilled receivable |
milestones-retainageMilestones and retainage | Progress claim and retainage strip |
formula-priced-shipmentsFormula-priced shipments | Formula-reset receivable |
setoff-nettingSetoff and netting | Obligor-level net-settlement claim |
For the existing local asset and buyer tools, see Assets and cohorts for agents.