API guide
Career Health API
Career Health API focuses on health metrics, trends, and alerts.
Path: /api/v1/career-health
Format: AI-first docs
Info
Contract-backed page
This page is generated from the current OpenAPI contract summary so docs stay aligned with the formal API surface.
GET /api/v1/career-health
Get career health report
Returns a comprehensive health report (metrics + alerts + recommendations).
Required scopes
read:career_health
Request
- no extra request parameters
Responses
- 200: OK
- 401:
- 403:
- 429:
- 500:
Errors
none documented
Examples
Code sample (curl)
1
curl "https://api.profileclaw.com/api/v1/career-health" -H "Authorization: Bearer $PROFILECLAW_API_KEY"Related surfaces
Use these surfaces when you need deeper inspection or automation.