API v1Endpoints
Meta endpoints
Health checks and session identity.
GET /v1/health
Simple v1 health check.
- Auth: none
- Response:
{ "ok": true }GET /v1/whoami
Returns the currently authenticated Clerk session identity.
- Auth: Clerk session (cookie/session token)
- Notes:
- This is not a Platform API-key endpoint.
- Intended for first-party web app/dashboard flows to validate the current user session.
- Third-party integrations should generally ignore this endpoint and use API-key endpoints instead.
Response
{
"userId": "user_...",
"sessionId": "sess_...",
"primaryEmail": "name@example.com"
}Unauthorized response
This endpoint returns a JSON error with status 401 when the session is missing/invalid:
{
"error": {
"_tag": "Unauthorized",
"message": "Unauthorized"
}
}