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 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 endpoint​

GET BaseURL/v1/Connections/{connectionId}

  • 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 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 returns 400 Bad Request.

Path variables​

Path variableData typeDescriptionDefault value
connectionId (required)stringThe ID of the connection you want to retrieve.NA

Query parameters​

Query parameterData typeDescriptionDefault value
includeConfigsbooleanReturns 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

Responses​

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": "Enabled",
  "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": "Enabled",
  "isDefault": true,
  "createTime": "2026-09-10T10:20:24.485Z",
  "updateTime": "2026-09-10T10:20:24.485Z"
}

Field names are in camelCase. Enum values keep their casing, for example state is Enabled or Failed. Fields without a value are left out of the response instead of being returned as null.

The response includes the connectionType field when the request sets includeConfigs to true. Without includeConfigs, the field can be absent from the response. The value is one of the following:

  • Public: a Standard connection, which uses the default public connector APIs.
  • Private: a private connection, which routes traffic through UiPath Relay or Private Link. For details, see Connecting to on-premises systems.

connectionType describes the connection. It is not the same as connector.isPrivate, which shows whether the connector itself is a private (custom) connector.

400 Bad Request​

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

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.

404 Not Found​

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.

  • API endpoint​
  • Request headers​
  • Path variables​
  • Query parameters​
  • Responses​
  • 200 OK​
  • 400 Bad Request​
  • 401 Unauthorized​
  • 403 Forbidden​
  • 404 Not Found​

Was this page helpful?

Connect

Need help? Support(opens in new window)

Want to learn? UiPath Academy(opens in new window)

Have questions? UiPath Forum(opens in new window)

Stay updated