Get connection by ID

API reference for retrieving a single Integration Service connection by ID, with the endpoint URL, path parameters, and example response.

Retrieves a single connection by ID.

API エンドポイント

GET BaseURL/v1/Connections/{connectionId}

• Use the Connections API Base URL for the cloud platform you are on.

要求ヘッダー

ヘッダー	値 (Value)
認可	Bearer <your-access-token>
X-UIPATH-AccountId	<tenant>
X-UIPATH-FolderKey	The key of the folder holding the connections

角括弧で囲まれた値 <...> をすべて、対応するユース ケース値に置き換えます。

The token is the one you received when you authorized the external application. It is available for 1 hour, then you need to generate a new one, or request a refresh token. See API access for how to register an external application and obtain this token.

重要:

External applications must target a single folder, identified by the X-UIPATH-FolderKey header. A request that omits the header returns 400 Bad Request.

Path 変数

Path 変数	データ型	説明	既定値
connectionId (required)	string	The ID of the connection you want to retrieve.	NA

クエリ パラメーター

クエリ パラメーター	データ型	説明	既定値
includeConfigs	boolean	Returns the connection's configuration. Available only to callers holding the configuration read scope. Secret values, such as API keys and OAuth tokens, are never returned.	false

応答

200 OK

{
  "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "Name": "My Salesforce connection",
  "Connector": {
    "Key": "uipath-salesforce-sfdc",
    "Name": "Salesforce"
  },
  "Folder": {
    "Key": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  },
  "State": "Connected",
  "IsDefault": true,
  "CreateTime": "2026-09-10T10:20:24.485Z",
  "UpdateTime": "2026-09-10T10:20:24.485Z"
}

400 Bad Request

The request did not supply the X-UIPATH-FolderKey header.

401 未承認

The access token is missing, expired, or invalid.

403 Forbidden

The external application does not hold the required scope, or it has no Connections.View permission in the requested folder.

404 見つかりません

The connection does not exist, or it is in a folder other than the one the request targeted. A connection outside the requested folder returns 404, not 403.