Return the current authenticated API session context.

Required scope: read

GET /api/v1/auth/session

cURL

curl --request GET \
  --url 'https://api.nsr.stateset.com/api/v1/auth/session' \
  --header "X-API-Key: $STATESET_NSR_API_KEY"

200

{
  "auth_type": "string",
  "email": "[e-mail]",
  "name": "Two-Person Tent",
  "org_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "rate_limit_per_minute": 8,
  "scopes": [
    "read"
  ],
  "user_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

Required scope: read

Response

AuthSessionResponse

auth_type · string · required

email · string

name · string

org_id · string

rate_limit_per_minute · integer (int32)

scopes · ApiScope[] · required

user_id · string

Status codes

Code	Meaning
200	Authenticated session context
401	Unauthorized — missing or invalid credentials
403	Forbidden — the key/token lacks the required scope
429	Rate limited — see Retry-After / X-RateLimit-Reset

cURL

curl --request GET \
  --url 'https://api.nsr.stateset.com/api/v1/auth/session' \
  --header "X-API-Key: $STATESET_NSR_API_KEY"

200

{
  "auth_type": "string",
  "email": "[e-mail]",
  "name": "Two-Person Tent",
  "org_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "rate_limit_per_minute": 8,
  "scopes": [
    "read"
  ],
  "user_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}