API guide
Assessments API
Assessments API shows the available assessment surfaces and where they fit in the product flow.
Path: /api/v1/assessments
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/assessments
Get assessment results for the authenticated user
Returns the user’s latest assessment signals (RIASEC, Big Five, Values).
Required scopes
read:assessments
Request
- no extra request parameters
Responses
- 200: OK
- 401:
- 403:
- 404:
- 429:
- 500:
Errors
none documented
Examples
Code sample (curl)
1
curl "https://api.profileclaw.com/api/v1/assessments" -H "Authorization: Bearer $PROFILECLAW_API_KEY"Code sample (curl)
1
curl "https://api.profileclaw.com/api/v1/assessments" -H "X-API-Key: $PROFILECLAW_API_KEY"Related surfaces
Use these surfaces when you need deeper inspection or automation.