Dropbox: Get the space usage information for the current user's account
Dropbox users.getSpaceUsage: arguments, response, policy and SDK examples.
← Users operations · Get started
Operation dropbox.users_get_space_usage
Provider route: POST /2/users/get_space_usage. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/dropbox with npm, or alter-sdk-dropbox with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { DropboxIntegration } from "@alter-ai/dropbox";
async function execute(input: Parameters<DropboxIntegration["users"]["getSpaceUsage"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new DropboxIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.users.getSpaceUsage(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_dropbox import DropboxIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = DropboxIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.users.get_space_usage(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
headers | object | Optional | Additional keys: not allowed |
headers.Dropbox-API-Path-Root | Model | Optional | Expand Deletes a group — request body — headers Dropbox-API-Path-Root |
headers.Dropbox-API-Select-User | string | Optional | |
headers.Dropbox-API-Select-Admin | string | Optional |
Referenced models: Deletes a group — request body — headers Dropbox-API-Path-Root
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand Get the space usage information for the current user’s account — response body |
Referenced models: Get the space usage information for the current user’s account — response body
Schemas
Section titled “Schemas”Deletes a group — request body — headers Dropbox-API-Path-Root
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | string | Alternative | One of: home |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: home |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3)..tag | string | Required within parent | Must equal: root |
$ (anyOf 3).root | string | Required within parent | Pattern: ^(?:[-_0-9a-zA-Z:]+)$ |
$ (anyOf 4) | object | Alternative | |
$ (anyOf 4)..tag | string | Required within parent | Must equal: namespace_id |
$ (anyOf 4).namespace_id | string | Required within parent | Pattern: ^(?:[-_0-9a-zA-Z:]+)$ |
$ (anyOf 5) | object | Alternative | A tag this contract version does not list (Dropbox's other). |
$ (anyOf 5)..tag | string | Required within parent | Pattern: ^(?!(?:home|root|namespace_id)$) |
Get the space usage information for the current user's account — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Information about a user's space usage and quota. |
used | JSON | Required within parent | |
used (anyOf 1) | integer | Alternative | Minimum: 0 |
used (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
allocation | Model | Required within parent | Expand Get the space usage information for the current user's account — response body — allocation |
Referenced models: Get the space usage information for the current user's account — response body — allocation
Get the space usage information for the current user's account — response body — allocation
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | Space is allocated differently based on the type of account. |
$ (anyOf 1) | object | Alternative | |
$ (anyOf 1)..tag | string | Required within parent | Must equal: individual |
$ (anyOf 1).allocated | JSON | Required within parent | |
$ (anyOf 1).allocated (anyOf 1) | integer | Alternative | Minimum: 0 |
$ (anyOf 1).allocated (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: team |
$ (anyOf 2).used | JSON | Required within parent | |
$ (anyOf 2).used (anyOf 1) | integer | Alternative | Minimum: 0 |
$ (anyOf 2).used (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (anyOf 2).allocated | JSON | Required within parent | |
$ (anyOf 2).allocated (anyOf 1) | integer | Alternative | Minimum: 0 |
$ (anyOf 2).allocated (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (anyOf 2).user_within_team_space_allocated | JSON | Required within parent | |
$ (anyOf 2).user_within_team_space_allocated (anyOf 1) | integer | Alternative | Minimum: 0 |
$ (anyOf 2).user_within_team_space_allocated (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (anyOf 2).user_within_team_space_limit_type | Model | Required within parent | Expand Get the space usage information for the current user's account — response body — allocation tag team user within team space limit type |
$ (anyOf 2).user_within_team_space_used_cached | JSON | Required within parent | |
$ (anyOf 2).user_within_team_space_used_cached (anyOf 1) | integer | Alternative | Minimum: 0 |
$ (anyOf 2).user_within_team_space_used_cached (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (anyOf 3) | object | Alternative | A tag this contract version does not list (Dropbox's other). |
$ (anyOf 3)..tag | string | Required within parent | Pattern: ^(?!(?:individual|team)$) |
Referenced models: Get the space usage information for the current user's account — response body — allocation tag team user within team space limit type
Get the space usage information for the current user's account — response body — allocation tag team user within team space limit type
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | The type of the space limit imposed on a team member. |
$ (anyOf 1) | string | Alternative | Known values: off, alert_only, stop_sync |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: off |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3)..tag | string | Required within parent | Must equal: alert_only |
$ (anyOf 4) | object | Alternative | |
$ (anyOf 4)..tag | string | Required within parent | Must equal: stop_sync |
$ (anyOf 5) | object | Alternative | A tag this contract version does not list (Dropbox's other). |
$ (anyOf 5)..tag | string | Required within parent | Pattern: ^(?!(?:off|alert_only|stop_sync)$) |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: dropbox.users_get_space_usage. Catalog operation: users/get_space_usage. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.
Required provider scopes: ["account_info.read"]