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.

请求标头

页眉	值
授权	承载 <your-access-token>
X-UIPATH-AccountId	<tenant>
X-UIPATH-文件夹密钥	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.

路径变量

路径变量	数据类型	描述	默认值
connectionId (required)	string	The ID of the connection you want to retrieve.	不适用

查询参数

查询参数	数据类型	描述	默认值
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.