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

getAll()

getAll<T>(options?: T): Promise<T extends HasPaginationOptions<T> ? PaginatedResponse<FolderGetAllResponse> : NonPaginatedResponse<FolderGetAllResponse>>

Gets the folders the calling user has access to, across the tenant.

Each folder carries its id, key, display name, fully qualified path, folder type and parent reference.

Without pagination options, a single page is returned at the server's default page size. Compare totalCount with items.length, or page with pageSize and cursor, to retrieve every folder. A jumpToPage past the last page returns no items with totalCount: 0.

Type Parameters

Type Parameter Default type
T extends PaginationOptions PaginationOptions

Parameters

Parameter Type Description
options? T Optional pagination options.

Returns

Promise<T extends HasPaginationOptions<T> ? PaginatedResponse<FolderGetAllResponse> : NonPaginatedResponse<FolderGetAllResponse>>

Promise resolving to a NonPaginatedResponse of FolderGetAllResponse without pagination options, or a PaginatedResponse of FolderGetAllResponse when pagination options are used.

Examples

// Get folders (first page at the server's default page size)
const result = await folders.getAll();
result.items.forEach(folder => console.log(folder.fullyQualifiedName));
// Page through every folder
let page = await folders.getAll({ pageSize: 100 });
const allFolders = [...page.items];
while (page.hasNextPage && page.nextCursor) {
  page = await folders.getAll({ cursor: page.nextCursor });
  allFolders.push(...page.items);
}

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