Skip to main content
GET
/
auth
/
fetch_user_quota
Get User Quota
curl --request GET \
  --url https://api.example.com/auth/fetch_user_quota

Get User Quota

Retrieve usage quota information for the currently authenticated user, including limits and current usage.

Endpoint

GET /auth/fetch_user_quota

Authentication

Requires JWT token authentication.
Authorization: Bearer <jwt_token>

Example Request

curl -X GET https://api.app.shinzo.ai/auth/fetch_user_quota \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIs..."

Response

{
  "plan": "free",
  "quotas": {
    "agents": {
      "limit": 3,
      "used": 1
    },
    "telemetry_events_per_month": {
      "limit": 100000,
      "used": 45230
    },
    "api_requests_per_minute": {
      "limit": 1000,
      "used": 0
    }
  },
  "features": {
    "ai_agents": true,
    "spotlight": true,
    "advanced_analytics": false
  }
}

Response Fields

FieldTypeDescription
planstringUser’s subscription plan
quotasobjectUsage limits and current usage for various resources
featuresobjectFeature flags indicating which features are enabled

Status Codes

CodeDescription
200Success
401Invalid or missing token