Skip to content

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.

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 os
from alter_sdk import App
from 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()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
headersobjectOptionalAdditional keys: not allowed
headers.Dropbox-API-Path-RootModelOptionalExpand Deletes a group — request body — headers Dropbox-API-Path-Root
headers.Dropbox-API-Select-UserstringOptional
headers.Dropbox-API-Select-AdminstringOptional
bodyModelRequired within parentExpand 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 media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Returns the space limit configuration of a team folder — response body

Referenced models: Returns the space limit configuration of a team folder — response body

Deletes a group — request body — headers Dropbox-API-Path-Root
FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)stringAlternativeOne of: home
$ (anyOf 2)objectAlternative
$ (anyOf 2)..tagstringRequired within parentMust equal: home
$ (anyOf 3)objectAlternative
$ (anyOf 3)..tagstringRequired within parentMust equal: root
$ (anyOf 3).rootstringRequired within parentPattern: ^(?:[-_0-9a-zA-Z:]+)$
$ (anyOf 4)objectAlternative
$ (anyOf 4)..tagstringRequired within parentMust equal: namespace_id
$ (anyOf 4).namespace_idstringRequired within parentPattern: ^(?:[-_0-9a-zA-Z:]+)$
$ (anyOf 5)objectAlternativeA tag this contract version does not list (Dropbox's other).
$ (anyOf 5)..tagstringRequired within parentPattern: ^(?!(?:home|root|namespace_id)$)
Returns the space limit configuration of a team folder — response body
FieldTypePresenceDescription and constraints
$objectRootThe 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_bytesJSONOptional
space_limit_bytes (anyOf 1)integerAlternativeMinimum: 0
space_limit_bytes (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
caps_typeModelRequired within parentExpand Returns the space limit configuration of a team folder — response body — caps type
notification_targetModelRequired within parentExpand 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
FieldTypePresenceDescription and constraints
$objectRoot
team_folder_idstringRequired within parentPattern: ^(?:[-_0-9a-zA-Z:]+)$
Returns the space limit configuration of a team folder — response body — caps type
FieldTypePresenceDescription and constraints
$JSONRootHow a team folder's space limit is enforced.
$ (anyOf 1)stringAlternativeKnown values: off, soft, hard
$ (anyOf 2)objectAlternative
$ (anyOf 2)..tagstringRequired within parentMust equal: off
$ (anyOf 3)objectAlternative
$ (anyOf 3)..tagstringRequired within parentMust equal: soft
$ (anyOf 4)objectAlternative
$ (anyOf 4)..tagstringRequired within parentMust equal: hard
$ (anyOf 5)objectAlternativeA tag this contract version does not list (Dropbox's other).
$ (anyOf 5)..tagstringRequired within parentPattern: ^(?!(?:off|soft|hard)$)
Returns the space limit configuration of a team folder — response body — notification target
FieldTypePresenceDescription and constraints
$JSONRootWho 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)stringAlternativeKnown values: admins, editors, both, silent
$ (anyOf 2)objectAlternative
$ (anyOf 2)..tagstringRequired within parentMust equal: admins
$ (anyOf 3)objectAlternative
$ (anyOf 3)..tagstringRequired within parentMust equal: editors
$ (anyOf 4)objectAlternative
$ (anyOf 4)..tagstringRequired within parentMust equal: both
$ (anyOf 5)objectAlternative
$ (anyOf 5)..tagstringRequired within parentMust equal: silent
$ (anyOf 6)objectAlternativeA tag this contract version does not list (Dropbox's other).
$ (anyOf 6)..tagstringRequired within parentPattern: ^(?!(?:admins|editors|both|silent)$)

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"]

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.