Queues

Service for managing UiPath Queues

Queues are a fundamental component of UiPath automation that enable distributed and scalable processing of work items. UiPath Queues Guide

Methods¶

getAll()¶

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

Gets all queues across folders with optional filtering and folder scoping

Type Parameters¶

Type Parameter	Default type
`T` extends `QueueGetAllOptions`	`QueueGetAllOptions`

Parameters¶

Parameter	Type	Description
`options?`	`T`	Query options including optional folderId and pagination options

Returns¶

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

Promise resolving to either an array of queues NonPaginatedResponse or a PaginatedResponse when pagination options are used. QueueGetResponse

Signature¶

getAll(options?) → Promise<QueueGetResponse[]>

Example¶

// Standard array return
const queues = await sdk.queues.getAll();

// Get queues within a specific folder
const queues = await sdk.queues.getAll({ 
  folderId: <folderId>
});

// Get queues with filtering
const queues = await sdk.queues.getAll({ 
  filter: "name eq 'MyQueue'"
});

// First page with pagination
const page1 = await sdk.queues.getAll({ pageSize: 10 });

// Navigate using cursor
if (page1.hasNextPage) {
  const page2 = await sdk.queues.getAll({ cursor: page1.nextCursor });
}

// Jump to specific page
const page5 = await sdk.queues.getAll({
  jumpToPage: 5,
  pageSize: 10
});

getById()¶

getById(
   id: number, 
   folderId: number, 
   options?: BaseOptions): Promise<QueueGetResponse>;

Gets a single queue by ID

Parameters¶

Parameter	Type	Description
`id`	`number`	Queue ID
`folderId`	`number`	Required folder ID
`options?`	`BaseOptions`	-

Returns¶

Promise<QueueGetResponse>

Promise resolving to a queue definition

Example¶

// Get queue by ID 
const queue = await sdk.queues.getById(<queueId>, <folderId>);