Dropbox: Retrieves metadata for team folders

← Team operations · Get started

Operation dropbox.team_team_folder_get_info

Provider route: POST /2/team/team_folder/get_info. Alter supplies the connection’s credentials and routing.

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"]["teamFolderGetInfo"]>[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.teamFolderGetInfo(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_get_info(arguments)
        result = await call.wait()
        return result.body_json()

Input

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 Retrieves metadata for team folders — request body — body

Referenced models: Deletes a group — request body — headers Dropbox-API-Path-Root, Retrieves metadata for team folders — request body — body

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
$	array	Root
$[]	Model	Each item	Expand Retrieves metadata for team folders — response body — item

Referenced models: Retrieves metadata for team folders — response body — item

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)$)

Retrieves metadata for team folders — response body — item

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	object	Alternative
$ (anyOf 1)..tag	string	Required within parent	Must equal: id_not_found
$ (anyOf 1).id_not_found	string	Required within parent
$ (anyOf 2)	object	Alternative
$ (anyOf 2)..tag	string	Required within parent	Must equal: team_folder_metadata
$ (anyOf 2).team_folder_id	string	Required within parent	Pattern: ^(?:[-_0-9a-zA-Z:]+)$
$ (anyOf 2).name	string	Required within parent
$ (anyOf 2).status	Model	Required within parent	Expand Changes an active team folder's name — response body — status
$ (anyOf 2).is_team_shared_dropbox	boolean	Required within parent
$ (anyOf 2).sync_setting	Model	Required within parent	Expand Changes an active team folder's name — response body — sync setting
$ (anyOf 2).content_sync_settings	array	Required within parent
$ (anyOf 2).content_sync_settings[]	Model	Each item	Expand Changes an active team folder's name — response body — content sync settings item
$ (anyOf 2).quota_limit	JSON	Optional
$ (anyOf 2).quota_limit (anyOf 1)	integer	Alternative
$ (anyOf 2).quota_limit (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Changes an active team folder's name — response body — content sync settings item, Changes an active team folder's name — response body — sync setting, Changes an active team folder's name — response body — status

Retrieves metadata for team folders — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
team_folder_ids	array	Required within parent	Minimum items: 1
team_folder_ids[]	string	Each item	Pattern: ^(?:[-_0-9a-zA-Z:]+)$

Changes an active team folder's name — response body — content sync settings item

Field	Type	Presence	Description and constraints
$	object	Root
id	string	Required within parent	Minimum length: 4 Pattern: ^(?:id:.+)$
sync_setting	Model	Required within parent	Expand Changes an active team folder's name — response body — sync setting

Referenced models: Changes an active team folder's name — response body — sync setting

Changes an active team folder's name — response body — sync setting

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	string	Alternative	Known values: default, not_synced, not_synced_inactive
$ (anyOf 2)	object	Alternative
$ (anyOf 2)..tag	string	Required within parent	Must equal: default
$ (anyOf 3)	object	Alternative
$ (anyOf 3)..tag	string	Required within parent	Must equal: not_synced
$ (anyOf 4)	object	Alternative
$ (anyOf 4)..tag	string	Required within parent	Must equal: not_synced_inactive
$ (anyOf 5)	object	Alternative	A tag this contract version does not list (Dropbox's other).
$ (anyOf 5)..tag	string	Required within parent	Pattern: ^(?!(?:default|not_synced|not_synced_inactive)$)

Changes an active team folder's name — response body — status

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	string	Alternative	Known values: active, archived, archive_in_progress, inactive
$ (anyOf 2)	object	Alternative
$ (anyOf 2)..tag	string	Required within parent	Must equal: active
$ (anyOf 3)	object	Alternative
$ (anyOf 3)..tag	string	Required within parent	Must equal: archived
$ (anyOf 4)	object	Alternative
$ (anyOf 4)..tag	string	Required within parent	Must equal: archive_in_progress
$ (anyOf 5)	object	Alternative
$ (anyOf 5)..tag	string	Required within parent	Must equal: inactive
$ (anyOf 6)	object	Alternative	A tag this contract version does not list (Dropbox's other).
$ (anyOf 6)..tag	string	Required within parent	Pattern: ^(?!(?:active|archived|archive_in_progress|inactive)$)

Policy, approvals and errors

SDK function policy ID: dropbox.team_team_folder_get_info. Catalog operation: team/team_folder_get_info. 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