Skip to content

Folders

Service for looking up UiPath Orchestrator folders.

Folders organize automations, queues, assets, and other resources, and scope most Orchestrator API calls. UiPath Folders Guide

Usage

Prerequisites: Initialize the SDK first - see Getting Started

import { Folders } from '@uipath/uipath-typescript/folders';

const folders = new Folders(sdk);
const folder = await folders.getByKey('<folderKey>');

Methods

getByKey()

getByKey(key: string, options?: FolderGetByKeyOptions): Promise<FolderGetResponse>

Gets a single folder by its key (GUID). Unlike most Orchestrator reads, this lookup is not folder-scoped: no folder headers are sent.

Parameters

Parameter Type Description
key string Folder key (GUID).
options? FolderGetByKeyOptions Optional query options (select).

Returns

Promise<FolderGetResponse>

Promise resolving to the matching FolderGetResponse. Rejects with ValidationError when key is missing or not a GUID, and with NotFoundError when no folder matches the key.

Examples

// Get a folder by key
const folder = await folders.getByKey('<folderKey>');

// With select
const folder = await folders.getByKey('<folderKey>', { select: 'fullyQualifiedName' });
console.log(folder.fullyQualifiedName);