Deel: List Organization Secure Vault Folder Items
Deel documents.listOrganizationSecureVaultFolderItems: arguments, response, policy and SDK examples.
← Documents operations · Get started
Operation deel.documents_listorganizationsecurevaultfolderitems_v2026_08_05
Provider route: GET /organizations/secure-vault/folders/{folder_id}/items. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/deel with npm, or alter-sdk-deel with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { DeelIntegration } from "@alter-ai/deel";
async function execute(input: Parameters<DeelIntegration["documents"]["listOrganizationSecureVaultFolderItems"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new DeelIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.documents.listOrganizationSecureVaultFolderItems(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_deel import DeelIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = DeelIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.documents.list_organization_secure_vault_folder_items(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.folder_id | string | Required within parent | Format: uuid |
query | object | Optional | Additional keys: not allowed |
query.limit | integer | Optional | Default: 20 Maximum: 100 Minimum: 1 |
query.cursor | string | Optional | Maximum length: 2048 |
query.search | string | Optional | Maximum length: 255 |
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 List Organization Secure Vault Folder Items — 200 response body |
Referenced models: List Organization Secure Vault Folder Items — 200 response body
Schemas
Section titled “Schemas”List Organization Secure Vault Folder Items — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | Folders and files for this page. |
data[] | Model | Each item | Expand List Organization Secure Vault Folder Items — 200 response body — data item |
has_more | boolean | Required within parent | Whether another page of results is available. |
next_cursor | JSON | Required within parent | |
next_cursor (anyOf 1) | string | Alternative | Cursor for the next page. Null when there are no more pages. |
next_cursor (anyOf 2) | null | Alternative | Cursor for the next page. Null when there are no more pages. |
total_count | JSON | Required within parent | |
total_count (anyOf 1) | integer | Alternative | Total number of matching records. Minimum: 0 |
total_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: List Organization Secure Vault Folder Items — 200 response body — data item
List Organization Secure Vault Folder Items — 200 response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
content_type | JSON | Optional | |
content_type (anyOf 1) | string | Alternative | MIME type. Files only. |
content_type (anyOf 2) | null | Alternative | MIME type. Files only. |
created_at | JSON | Optional | |
created_at (anyOf 1) | string | Alternative | Creation timestamp. Format: date-time |
created_at (anyOf 2) | null | Alternative | Creation timestamp. Format: date-time |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | Folder description. Null for files. |
description (anyOf 2) | null | Alternative | Folder description. Null for files. |
folder_id | JSON | Optional | |
folder_id (anyOf 1) | string | Alternative | Public UUID of the containing folder. Files only. Format: uuid |
folder_id (anyOf 2) | null | Alternative | Public UUID of the containing folder. Files only. Format: uuid |
id | JSON | Required within parent | |
id (anyOf 1) | string | Alternative | Public UUID of the folder or file. Format: uuid |
id (anyOf 2) | null | Alternative | Public UUID of the folder or file. Format: uuid |
is_sub_folder | boolean | Optional | Whether the folder is nested under another folder. Folders only. |
item_type | JSON | Optional | Specific kind of folder or file. |
item_type (anyOf 1) | string | Alternative | Specific kind of folder or file. Known values: CUSTOM_FOLDER, REGISTRATION_DOC_FOLDER, DOCUMENTS_TO_SIGN_FOLDER, REGISTRATION_DOC_FILE, SECURE_FILE_VAULT_FILE, DOCUMENTS_TO_SIGN_FILE |
item_type (anyOf 2) | null | Alternative | |
name | JSON | Required within parent | |
name (anyOf 1) | string | Alternative | Folder name, or the original filename for a file. |
name (anyOf 2) | null | Alternative | Folder name, or the original filename for a file. |
parent_folder_id | JSON | Optional | |
parent_folder_id (anyOf 1) | string | Alternative | Parent folder public UUID. Folders only. Format: uuid |
parent_folder_id (anyOf 2) | null | Alternative | Parent folder public UUID. Folders only. Format: uuid |
type | string | Required within parent | Discriminates folders from files. Known values: FOLDER, FILE |
uploaded_by | JSON | Optional | Who uploaded the file. Files only. |
uploaded_by (anyOf 1) | Model | Alternative | Expand List Organization Secure Vault Folder Items — 200 response body — data item uploaded by Who uploaded the file Files only |
uploaded_by (anyOf 2) | null | Alternative |
Referenced models: List Organization Secure Vault Folder Items — 200 response body — data item uploaded by Who uploaded the file Files only
List Organization Secure Vault Folder Items — 200 response body — data item uploaded by Who uploaded the file Files only
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Who uploaded the file. Files only. |
name | string | Optional | Display name of the uploader. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: deel.documents_listorganizationsecurevaultfolderitems_v2026_08_05. Catalog operation: documents_listorganizationsecurevaultfolderitems_v2026_08_05. 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: ["organizations:read"]
Pinned headers: {"X-Version": "2026-08-05"}