List quick wins

GET/api/public/quick-wins

List automatically detected positive moments for your trainees (new personal record, consistency streak, measurement progress, coaching milestone), newest first. Uses cursor pagination: pass the returned nextCursor to fetch the next page.

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
NameTypeDescription
cursorstring

Cursor from the previous response (nextCursor).

limitinteger

Items per page. Defaults to 15.

Minimum: 1

Maximum: 100

filterstring

Return wins still awaiting action, or ones already handled. Defaults to active.

Allowed values: active handled

searchstring

Search the trainee name.

Request examples

cURL
curl --request GET \
  --url 'https://api.coach-platform.com/api/public/quick-wins' \
  --header 'Authorization: Bearer cp_live_...'
JavaScript (fetch)
const response = await fetch('https://api.coach-platform.com/api/public/quick-wins', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer cp_live_...',
  },
});

const data = await response.json();

Responses

200 OK

Example body (application/json)
{
  "data": [
    {
      "id": "<string>",
      "trainee": {
        "id": "<string>",
        "fullName": "<string>"
      },
      "category": "<string>",
      "title": "<string>",
      "description": "<string>",
      "status": "<string>",
      "createdAt": "<date-time>"
    }
  ],
  "nextCursor": "<string>"
}
Response fields (11)
Response fields
NameTypeDescription
dataobject[]
data[].idstring
data[].traineeobject
data[].trainee.idstring
data[].trainee.fullNamestring
data[].categorystring

Win category, e.g. personalRecord, streak, measurement.

data[].titlestring

Short human-readable summary of the win.

data[].descriptionstring
data[].statusstring

active or handled.

data[].createdAtstring<date-time>
nextCursorstring | null

Pass as cursor to fetch the next page. Null when there are no more results.

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