Coach API

Get the authenticated coach profile

GET/api/public/me

Returns the authenticated coach profile (name, email, plan limits).

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.

Request examples

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

const data = await response.json();

Responses

200 OK

Successful response

Example body (application/json)
{
  "data": {
    "id": "<string>",
    "name": "<string>",
    "email": "<string>",
    "phoneNumber": "<string>",
    "businessName": "<string>",
    "businessType": "<string>",
    "workMethod": "<string>",
    "businessColor": "<string>",
    "profileImageUrl": "<string>",
    "activeTraineesCount": 123,
    "traineesLimit": 123,
    "createdAt": "<date-time>"
  }
}
Response fields (13)
Response fields
NameTypeDescription
dataobject
data.idstring
data.namestring
data.emailstring
data.phoneNumberstring
data.businessNamestring
data.businessTypestring
data.workMethodstring
data.businessColorstring
data.profileImageUrlstring
data.activeTraineesCountnumber
data.traineesLimitnumber
data.createdAtstring<date-time>

Error responses

  • 400 Bad Request
  • 401 Unauthorized
  • 403 Forbidden
  • 404 Not Found
  • 409 Conflict
  • 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
NameTypeDescription
errorobject
error.codestring
error.messagestring
error.fixstring | null
error.detailsobject | null
error.retryAfterMsnumber | null

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