List the cohort vocabulary

GET

/api/v1/cohorts/{registry_type}

curl --request GET \
  --url https://api.pkgplease.com/api/v1/cohorts/example \
  --header 'Authorization: Bearer <token>'

• Production

Every pkgPlease-authored cohort with at least one reviewed member. A cohort is a kind of package (e.g. logging) whose members substitute for one another. The slugs are the valid values of suggest_allowed's cohort.

Authorizations

• orgToken

Parameters

Path Parameters

registry_type

required

string

One of the org's configured registry types (npm is the one in active use).

Responses

200

The vocabulary, ordered by slug

Media typeapplication/json

object

cohorts

Array<object>

object

slug

string

name

string

description

string

Example

{
  "cohorts": [
    {
      "slug": "logging",
      "name": "Logging"
    }
  ]
}

400

Unsupported registry type

Media typeapplication/json

object

error

required

string

Example^generated

{
  "error": "example"
}