coaching

List the user's coaching sessions

Changed on

Draft — not yet available.

The user's coaching sessions in a time window, for example upcoming sessions for reminders or past sessions for history. With no parameters, returns sessions that haven't ended yet, soonest first. For past sessions, send to set to the current time and order=desc. Cancelled and missed sessions are included; check status.

Call this endpoint with the user's own access token (UserTokenAuth). The token identifies the user, so there is no user parameter.

get/v1/coaching/sessions

Request

  • Base URL
    https://partners-api.thriveglobal.com
  • Auth
    HTTP bearer

Query parameters

fromstring date-time

Returns sessions that end after this time, so a session in progress at from is included. RFC 3339. Defaults to the current time when neither from nor to is sent; when only to is sent, there is no lower limit.

tostring date-time

Returns sessions that start before this time. RFC 3339. No upper limit when omitted.

order'asc' | 'desc'

Sort order by startsAt. asc (default): soonest first. desc: most recent first.

offsetinteger

Zero-based item offset

limitinteger

Page size. Values above 100 are clamped to 100, not rejected; meta.pagination reports the applied value.

Response

A page of coaching sessions

Example response

{
  "data": [
    {
      "startsAt": "2027-01-14T20:00:00Z",
      "endsAt": "2027-01-14T20:30:00Z",
      "coach": {
        "firstName": "Sam"
      }
    }
  ],
  "meta": {
    "pagination": {
      "limit": 10
    }
  },
  "links": {
    "self": "/v1/soundscapes?offset=0&limit=10",
    "next": "/v1/soundscapes?offset=10&limit=10"
  }
}

Changes