Box Observer Docs
Open app
API / Reference

Account

Inspect your effective access, identity and configured limits.

Production · organization access required

Requests require an active organization grant and an API key or Clerk session. Results respect your granted scopes and markets. Access details →

GET/v1/account

Current authenticated access.

No parameters.

Shell · authenticated request
curl "https://api.boxobserver.com/v1/account" \
  -H "Authorization: Bearer $BOX_OBSERVER_API_KEY"

Response

200 application/json · Success shape within your granted access.

Illustrative response shape · not live data
{
  "data": {
    "authentication": "clerk",
    "keyId": null,
    "userId": null,
    "organizationId": null,
    "access": {
      "scopes": [],
      "countryCodes": [],
      "mode": "operator_markets",
      "operatorId": null
    },
    "capabilities": {
      "countryFiltering": true,
      "availableCountryCodes": []
    },
    "limits": {
      "maximumPageSize": 0,
      "maximumScheduleRangeDays": 0,
      "rateLimitPerMinute": 0
    }
  },
  "meta": {
    "requestId": "example-request-id",
    "generatedAt": "2026-09-04T12:00:00.000Z"
  }
}
Response fields
FieldType and constraints
dataRequiredobject
data.authenticationRequiredstringValues: clerk, apiKey
data.keyIdRequiredstring | null
data.userIdRequiredstring | null
data.organizationIdRequiredstring | null
data.accessRequiredobject
data.access.scopesRequiredarray<string>
data.access.countryCodesRequiredarray<string>
data.access.modeRequiredstringValues: operator_markets, countries
data.access.operatorIdRequiredstring | null
data.capabilitiesRequiredobject
data.capabilities.countryFilteringRequiredbooleanValues: true
data.capabilities.availableCountryCodesRequiredarray<string>
data.limitsRequiredobject
data.limits.maximumPageSizeRequiredinteger
data.limits.maximumScheduleRangeDaysRequiredinteger
data.limits.rateLimitPerMinuteRequiredinteger
metaRequiredobject
meta.requestIdRequiredstring
meta.generatedAtRequiredstringFormat: date-time

Errors: 400, 401, 403, 429, 500, 503. Response format and retry guidance →