API ReferenceUsage
Get usage snapshot
Returns the current quota usage for the authenticated project's organisation. Includes both cumulative totals (storage, file count) and period-reset metrics (monthly upload bytes, monthly request count).
Requires usage:read scope.
Authorization
bearerAuth usage:readAuthorizationBearer <token>
API token from your dashboard.
Format: so_live_... (production) or so_test_... (test mode).
Tokens carry one or more scopes. Request only the scopes your integration needs:
| Scope | Grants |
|---|---|
media:read | List and retrieve files |
media:write | Upload and delete files |
logs:read | Read log entries |
logs:write | Ingest log entries |
cases:read | Read cases |
cases:write | Create and update cases |
apps:read | Read apps |
apps:write | Submit apps |
usage:read | Read quota usage |
members:read | List organisation members |
members:write | Invite and remove members |
billing:read | Read billing and subscription info |
tokens:write | Create and revoke API tokens |
In: header
Scope: usage:read
Response Body
application/json
application/json
application/json
curl -X GET "https://example.com/usage"{
"period": "2026-05",
"metrics": [
{
"metric": "storage_bytes",
"used": 5368709120,
"limit": 10737418240,
"cumulative": true
},
{
"metric": "files_count",
"used": 1200,
"limit": 10000,
"cumulative": true
},
{
"metric": "uploaded_bytes_month",
"used": 1073741824,
"limit": 5368709120,
"cumulative": false,
"period": "2026-05"
},
{
"metric": "reqs_month",
"used": 45000,
"limit": 100000,
"cumulative": false,
"period": "2026-05"
}
]
}{
"error": {
"code": "unauthorized",
"message": "missing or invalid authorization token"
}
}{
"error": {
"code": "internal",
"message": "an unexpected error occurred"
}
}