Dropbox: Returns the space limit configuration of a team folder
Dropbox team.teamFolderSpaceLimitGet: arguments, response, policy and SDK examples.
← Team operations · Get started
Operation dropbox.team_team_folder_space_limit_get
Provider route: POST /2/team/team_folder/space_limit/get. 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["team"]["teamFolderSpaceLimitGet"]>[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.team.teamFolderSpaceLimitGet(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.team.team_folder_space_limit_get(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 | |
body | Model | Required within parent | Expand Permanently deletes an archived team folder — request body — body |
Referenced models: Deletes a group — request body — headers Dropbox-API-Path-Root, Permanently deletes an archived team folder — request body — body
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 Returns the space limit configuration of a team folder — response body |
Referenced models: Returns the space limit configuration of a team folder — 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)$) |
Returns the space limit configuration of a team folder — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The space limit configuration of a team folder. If no space limit has ever been set for the team folder, space_limit_bytes is 0, caps_type is TeamFolderSpaceLimitCapsType.off, and notification_target is TeamFolderSpaceLimitNotificationTarget.admins. |
space_limit_bytes | JSON | Optional | |
space_limit_bytes (anyOf 1) | integer | Alternative | Minimum: 0 |
space_limit_bytes (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
caps_type | Model | Required within parent | Expand Returns the space limit configuration of a team folder — response body — caps type |
notification_target | Model | Required within parent | Expand Returns the space limit configuration of a team folder — response body — notification target |
Referenced models: Returns the space limit configuration of a team folder — response body — caps type, Returns the space limit configuration of a team folder — response body — notification target
Permanently deletes an archived team folder — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
team_folder_id | string | Required within parent | Pattern: ^(?:[-_0-9a-zA-Z:]+)$ |
Returns the space limit configuration of a team folder — response body — caps type
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | How a team folder's space limit is enforced. |
$ (anyOf 1) | string | Alternative | Known values: off, soft, hard |
$ (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: soft |
$ (anyOf 4) | object | Alternative | |
$ (anyOf 4)..tag | string | Required within parent | Must equal: hard |
$ (anyOf 5) | object | Alternative | A tag this contract version does not list (Dropbox's other). |
$ (anyOf 5)..tag | string | Required within parent | Pattern: ^(?!(?:off|soft|hard)$) |
Returns the space limit configuration of a team folder — response body — notification target
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | Who receives email notifications when a team folder's usage reaches 80% of its space limit, and when usage reaches or exceeds the limit. These notifications are sent asynchronously, so they can arrive some time after usage crosses a threshold. They are only sent when the caps type is TeamFolderSpaceLimitCapsType.soft or TeamFolderSpaceLimitCapsType.hard. Regardless of this setting, team admins and all members with edit access to the team folder are notified when a space limit is added, changed, or removed. |
$ (anyOf 1) | string | Alternative | Known values: admins, editors, both, silent |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: admins |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3)..tag | string | Required within parent | Must equal: editors |
$ (anyOf 4) | object | Alternative | |
$ (anyOf 4)..tag | string | Required within parent | Must equal: both |
$ (anyOf 5) | object | Alternative | |
$ (anyOf 5)..tag | string | Required within parent | Must equal: silent |
$ (anyOf 6) | object | Alternative | A tag this contract version does not list (Dropbox's other). |
$ (anyOf 6)..tag | string | Required within parent | Pattern: ^(?!(?:admins|editors|both|silent)$) |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: dropbox.team_team_folder_space_limit_get. Catalog operation: team/team_folder_space_limit_get. 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: ["team_data.content.read"]