- 入门指南
- Connections API
- Get connections
- Get connection by ID
- Connectors API
API reference for listing Integration Service connections in a folder, with the endpoint URL, required headers, and example response.
Retrieves the connections in a folder.
API 端点
GET BaseURL/v1/Connections
- 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 <your-access-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, or that sets allFolders to true, returns 400 Bad Request.
查询参数
| 查询参数 | 数据类型 | 描述 | 默认值 |
|---|---|---|---|
| allFolders | boolean | Not supported for external applications. Setting it to true returns 400 Bad Request. | false |
响应
200 OK
Returns the connections in the requested folder. Responses to an external application exclude the connection owner, the element instance ID, the polling interval, and the bring-your-own-app flag.
[
{
"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"
}
]
[
{
"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, or it set allFolders to true. External applications must target one folder per request.
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.