Dropbox: Returns a list of file requests owned by this user — file Requests list V2

Dropbox fileRequests.listV2: arguments, response, policy and SDK examples.

← File requests operations · Get started

Operation dropbox.file_requests_list_v2

Provider route: POST /2/file_requests/list_v2. 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["fileRequests"]["listV2"]>[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.fileRequests.listV2(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.file_requests.list_v2(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 Returns a list of file requests owned by this user — file Requests list V2 — request body — body

Referenced models: Deletes a group — request body — headers Dropbox-API-Path-Root, Returns a list of file requests owned by this user — file Requests list V2 — 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
`$`	Model	Root	Expand Returns a list of file requests owned by this user — file Requests list V2 — response body

Referenced models: Returns a list of file requests owned by this user — file Requests list V2 — response body

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 a list of file requests owned by this user — file Requests list V2 — request body — body

Field	Type	Presence	Description and constraints
`$`	object	Root	Arguments for list:2.
`limit`	integer	Optional	Minimum: 0

Returns a list of file requests owned by this user — file Requests list V2 — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	Result for list:2 and list/continue.
`file_requests`	array	Required within parent
`file_requests[]`	Model	Each item	Expand Update a file request — response body
`cursor`	string	Required within parent
`has_more`	boolean	Required within parent

Referenced models: Update a file request — response body

Update a file request — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	A file request https://www.dropbox.com/help/9090 for receiving files into the user's Dropbox account.
`id`	string	Required within parent	Minimum length: 1 Pattern: ^(?:[-_0-9a-zA-Z]+)$
`url`	string	Required within parent	Minimum length: 1
`title`	string	Required within parent	Minimum length: 1
`destination`	JSON	Optional
`destination (anyOf 1)`	string	Alternative	Pattern: ^(?:/(.\|[\r\n])*)$
`destination (anyOf 2)`	null	Alternative
`created`	string	Required within parent
`deadline`	JSON	Optional
`deadline (anyOf 1)`	Model	Alternative	Expand Update a file request — response body — deadline allow late uploads, deadline
`deadline (anyOf 2)`	null	Alternative
`is_open`	boolean	Required within parent
`file_count`	JSON	Required within parent
`file_count (anyOf 1)`	integer	Alternative
`file_count (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`description`	JSON	Optional
`description (anyOf 1)`	string	Alternative
`description (anyOf 2)`	null	Alternative
`video_project_id`	JSON	Optional
`video_project_id (anyOf 1)`	string	Alternative
`video_project_id (anyOf 2)`	null	Alternative

Referenced models: Update a file request — response body — deadline allow late uploads, deadline

Update a file request — response body — deadline allow late uploads, deadline

Field	Type	Presence	Description and constraints
`$`	object	Root
`deadline`	string	Required within parent
`allow_late_uploads`	JSON	Optional
`allow_late_uploads (anyOf 1)`	Model	Alternative	Expand Update a file request — response body — deadline allow late uploads, deadline allow late uploads value
`allow_late_uploads (anyOf 2)`	null	Alternative

Referenced models: Update a file request — response body — deadline allow late uploads, deadline allow late uploads value

Update a file request — response body — deadline allow late uploads, deadline allow late uploads value

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

Policy, approvals and errors

SDK function policy ID: dropbox.file_requests_list_v2. Catalog operation: file_requests/list_v2. 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: ["file_requests.read"]

Official provider source

Report an issue with this page