Skip to main content

GET /api/v1/me

Return the authenticated user context and onboarding state.

Auth​

API key or session auth.

Request​

curl https://api.opendocs.cc/api/v1/me \
  -H "Authorization: Bearer od_live_xxxxx"

Success response​

{
  "authenticated": true,
  "userId": "usr_123",
  "onboarding": {
    "hasUsername": true,
    "hasWorkspace": true,
    "username": "yourteam",
    "workspace": {
      "id": "ws_123",
      "name": "Your Team",
      "slug": "your-team",
      "defaultVisibility": "workspace"
    },
    "completed": true
  }
}

Why it matters​

The CLI uses this endpoint during login to validate the key and learn:

  • the current username
  • the current workspace ID
  • whether onboarding is complete

Common errors​

{
  "error": "unauthorized"
}