Connections

Experimental

Warning

Preview: This service is experimental and may change or be removed in future releases.

Service for managing UiPath Integration Service connections.

A connection represents an authenticated link to a third-party system (Salesforce, Slack, OneDrive, ...) inside a UiPath folder. Use this service to list connections, or inspect a single connection.

Usage

Prerequisites: Initialize the SDK first - see Getting Started

import { Connections } from '@uipath/uipath-typescript/connections';

const connections = new Connections(sdk);
const allConnections = await connections.getAll();

Methods

getAll()

getAll(options?: ConnectionGetAllOptions): Promise<ConnectionGetResponse[]>

Experimental

Get all connections, optionally scoped to a folder.

Warning

Preview: This method is experimental and may change or be removed in future releases.

Returns a plain array of connection entities. Pagination is page-indexed via pageIndex/pageSize; there is no continuation cursor, so callers paginate by incrementing pageIndex until a short page is returned.

Folder scoping is optional — pass folderId, folderKey, or folderPath to list a folder's connections. When none is supplied, a deployed coded app's folder is used; elsewhere, including in a coded function, the service lists the caller's personal workspace, so a robot account, which has none, gets an empty list.

Parameters

Parameter	Type	Description
options?	ConnectionGetAllOptions	Folder scoping (folderId / folderKey / folderPath), paging, sorting, and filter options

Returns

Promise<ConnectionGetResponse[]>

Promise resolving to an array of ConnectionGetResponse

Examples

import { Connections } from '@uipath/uipath-typescript/connections';

const connections = new Connections(sdk);

// List the first page of connections in a folder
const folderConnections = await connections.getAll({
  folderKey: '<folderKey>',
  pageSize: 50,
});

for (const conn of folderConnections) {
  console.log(`${conn.name} (${conn.state})`);
}

// Filter by name and connector
const filtered = await connections.getAll({
  folderKey: '<folderKey>',
  filter: "connector.key eq 'uipath-slack'",
  mostRecentFirst: true,
});

// Scope by folder path or numeric folder ID instead of a key
const byPath = await connections.getAll({ folderPath: 'Shared/Finance' });
const byId = await connections.getAll({ folderId: 123 });

---

getById()

getById(connectionId: string, options?: ConnectionGetByIdOptions): Promise<ConnectionGetResponse>

Experimental

Get a single connection by ID.

Warning

Preview: This method is experimental and may change or be removed in future releases.

Parameters

Parameter	Type	Description
connectionId	string	Connection GUID
options?	ConnectionGetByIdOptions	Folder scoping (folderId / folderKey / folderPath) and optional includeConfigs flag

Returns

Promise<ConnectionGetResponse>

Promise resolving to a ConnectionGetResponse

Examples

import { Connections } from '@uipath/uipath-typescript/connections';

const connections = new Connections(sdk);

// First, list connections to find the connectionId
const list = await connections.getAll({ folderKey: '<folderKey>' });
const connectionId = list[0].id;

const conn = await connections.getById(connectionId);
console.log(conn.connector?.key, conn.state);

// Include the full configuration blob
const conn = await connections.getById('<connectionId>', { includeConfigs: true });

// Scope the lookup to a folder path
const conn = await connections.getById('<connectionId>', { folderPath: 'Shared/Finance' });