Resolve the authenticated client

This endpoint requires authentication. Include your API key in the X-API-KEY header with every request.

GET/client/v1/me

Smoke endpoint that confirms client-key auth resolves the principal.

Example Request
curl -X GET "https://api.proxied.com/client/v1/me" \
  -H "X-API-KEY: <api-key>"

Response Body

  • success
    boolean

    Always true on a successful response.

  • data
    object

    The client the key authenticates.

    • userId
      string | null

      The id of the client user the X-API-KEY belongs to, a 24-character hexadecimal string.

200 Response
{
  "success": true,
  "data": {
    "userId": "665f1c2e8b3f4a5d6e7f8091"
  }
}

Error Responses

Error shape
{
  "success": false,
  "error": {
    "code": "ERROR_CODE",
    "message": "readable message"
  }
}
StatusCodeDescription
401
MISSING_API_KEYMissing API key.
403
INVALID_API_KEYInvalid API key.
500
INTERNAL_ERRORInternal error.