UiPath Documentation
integration-service
latest
false
Integration Service API guide
  • Getting started
    • Base URL
  • Connections API
    • Get connections
    • Get connection by ID
  • Connectors API

Get connections

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 endpoint

GET BaseURL/v1/Connections

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

Request headers

HeaderValue
AuthorizationBearer <your-access-token>
X-UIPATH-AccountId<tenant>
X-UIPATH-FolderKeyThe key of the folder holding the connections

Replace all the values between the angle brackets <...> with their corresponding use-case values.

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.

Important:

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.

Query parameters

Query parameterData typeDescriptionDefault value
allFoldersbooleanNot supported for external applications. Setting it to true returns 400 Bad Request.false

Responses

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 Unauthorized

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.

  • API endpoint
  • Request headers
  • Query parameters
  • Responses
  • 200 OK
  • 400 Bad Request
  • 401 Unauthorized
  • 403 Forbidden

Was this page helpful?

Connect

Need help? Support

Want to learn? UiPath Academy

Have questions? UiPath Forum

Stay updated