List labels (GET /api/public/labels)

List all trainee labels (tags) defined by the coach.

Authentication

Requires an API key, sent as Authorization: Bearer cp_live_....

API keys carry scopes. Get the catalog of scopes and webhook events lists every scope.

Query parameters

Query parameters
Name	Type	Description
`page`	`integer`	Page number (1-based, default 1) Minimum: `1`
`limit`	`integer`	Number of items to return (default 25, max 500) Minimum: `1` Maximum: `500`

Request examples

cURL

curl --request GET \
  --url 'https://api.coach-platform.com/api/public/labels' \
  --header 'Authorization: Bearer cp_live_...'

JavaScript (fetch)

const response = await fetch('https://api.coach-platform.com/api/public/labels', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer cp_live_...',
  },
});

const data = await response.json();

Responses

`200` OK

Successful response

Example body (application/json)

{
  "data": [
    {
      "id": "<string>",
      "text": "<string>",
      "color": "<string>",
      "coachId": "<string>"
    }
  ],
  "pagination": {
    "page": 123,
    "limit": 123,
    "total": 123,
    "hasMore": true,
    "truncated": true
  }
}

Response fields (11)

Response fields
Name	Type	Description
`data`	`object[]`
`data[].id`	`string`
`data[].text`	`string`
`data[].color`	`string`
`data[].coachId`	`string`
`pagination`	`object`
`pagination.page`	`number`
`pagination.limit`	`number`
`pagination.total`	`number \| null`	Total number of matching items. null when the underlying source cannot report an exact count for this page; use hasMore to keep paging.
`pagination.hasMore`	`boolean`
`pagination.truncated`	`boolean`	Present and true when the result set exceeded the in-memory scan cap and was truncated. Narrow your filters to page through all items.

Error responses

400 Bad Request
401 Unauthorized
403 Forbidden
429 Too Many Requests
500 Internal Server Error

These statuses share the same response body.

Example body (application/json)

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "fix": "<string>",
    "details": {},
    "retryAfterMs": 123
  }
}

Error fields (6)

Error fields
Name	Type	Description
`error`	`object`
`error.code`	`string`
`error.message`	`string`
`error.fix`	`string \| null`
`error.details`	`object \| null`
`error.retryAfterMs`	`number \| null`

This page is also available as Markdown. Browse it in the interactive explorer or download the OpenAPI spec.