RoomScope

Last updated

Account

Plan, limits and credit usage of the key's workspace.

Every operation authenticates with an API key (Authorization: Bearer <key>) and errors use the shared envelope described in Errors. Generated from the API's OpenAPI document.

Get plan and limits

GET/v1/entitlements

The workspace's plan, modules, rate limits and credit wallet for a billing period.

Scopekeys:manageCreditsFree

Query parameters

Query parameters of GET /v1/entitlements
NameTypeDescription
periodOptional
stringBilling period start, YYYY-MM-01; defaults to the current one.

Request

curl "https://api.roomscope.io/v1/entitlements" \  -H "Authorization: Bearer $ROOMSCOPE_API_KEY"

Response

200 OK
{  "data": {    "workspaceId": "4388fdb0-ef68-5d01-ac84-b683b2b355e8",    "planCode": "agency",    "tier": "agency",    "modules": [      "live",      "lookup"    ],    "limits": {      "requestsPerWindow": 150,      "rateWindowMs": 1000,      "apiRequestsPerSecond": 150,      "requestsPerDay": 1200000,      "maxApiKeys": 0,      "wsConcurrencyCap": 200,      "maxRoomMinutesPerMonth": 800000,      "historyWindowDays": 365,      "maxSeats": 10,      "seatsUsed": 2,      "exportFormats": [        "csv",        "xlsx"      ]    },    "credits": {      "period": "2026-11-01",      "monthlyAllotment": 36000000,      "hardCap": 36000000,      "spent": 0,      "remaining": 0    }  },  "provenance": {    "observedAt": "2026-11-01T11:19:24.411834Z",    "freshness": "near_realtime",    "source": "plan_entitlement",    "coverageStatus": "observed",    "methodologyVersion": "entitlements-v1"  }}

Errors

  • 400 Invalid parameter or body; code names the problem.
  • 401 Missing or unknown API key.
  • 403 The key lacks the scope, or the plan does not include the feature.
  • 429 Request rate exceeded; honour Retry-After.

Get credit usage

GET/v1/usage

Credits spent per operation in a billing period.

Scopekeys:manageCreditsFree

Query parameters

Query parameters of GET /v1/usage
NameTypeDescription
periodOptional
stringBilling period start, YYYY-MM-01; defaults to the current one.
limitOptional
integerMaximum rows.

Request

curl "https://api.roomscope.io/v1/usage" \  -H "Authorization: Bearer $ROOMSCOPE_API_KEY"

Response

200 OK
{  "period": "2026-11-01",  "balance": {    "remaining": 0,    "spent": 0  },  "items": []}

Errors

  • 400 Invalid parameter or body; code names the problem.
  • 401 Missing or unknown API key.
  • 403 The key lacks the scope, or the plan does not include the feature.
  • 429 Request rate exceeded; honour Retry-After.
Was this page helpful?