Skyvern: Get folders

← Folders operations · Get started

Operation skyvern.get_folders_v1_folders_get

Provider route: GET /v1/folders. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/skyvern with npm, or alter-sdk-skyvern with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { SkyvernIntegration } from "@alter-ai/skyvern";

async function execute(input: Parameters<SkyvernIntegration["folders"]["getFolders"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new SkyvernIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.folders.getFolders(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_skyvern import SkyvernIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = SkyvernIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.folders.get_folders(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
query	object	Optional	Additional keys: not allowed
query.page	integer	Optional	Page number Default: 1 Minimum: 1
query.page_size	integer	Optional	Number of folders per page Default: 100 Maximum: 500 Minimum: 1
query.search	JSON	Optional	Search folders by title or description
query.search (anyOf 1)	string	Alternative
query.search (anyOf 2)	null	Alternative

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 Get folder — response body

Referenced models: Get folder — response body

Schemas

Get folder — response body

Field	Type	Presence	Description and constraints
$	object	Root	Response model for a folder
created_at	string	Required within parent	Format: date-time
description	JSON	Optional	Folder description
description (anyOf 1)	string	Alternative
description (anyOf 2)	null	Alternative
folder_id	string	Required within parent
modified_at	string	Required within parent	Format: date-time
organization_id	string	Required within parent
title	string	Required within parent	Folder title Maximum length: 255 Minimum length: 1
workflow_count	JSON	Optional
workflow_count (anyOf 1)	integer	Alternative	Number of workflows in this folder Default: 0
workflow_count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Policy, approvals and errors

SDK function policy ID: skyvern.get_folders_v1_folders_get. Catalog operation: get_folders_v1_folders_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.

Official provider source