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.

Ponto de Extremidade da API

GET BaseURL/v1/Connections/{connectionId}

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

Cabeçalhos de solicitação.

Cabeçalho	Valor
Autorização	O portador <your-access-token>
X-UIPATH-AccountId	<tenant>
ChaveDaPastaX-UIPATH	The key of the folder holding the connections

Substitua todos os valores entre os colchetes angulares <...> por seus valores de caso de uso correspondentes.

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.

Importante:

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

Variáveis de caminho

Variável Path	Tipo de dados	Description	Valor padrão
connectionId (required)	string	The ID of the connection you want to retrieve.	NA

Parâmetros de Consulta

Parâmetro de consulta	Tipo de dados	Description	Valor padrão
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

Resposta

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 não autorizado

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 Não encontrado

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.