Obter conexões

Referência de API para listar conexões do Integration Service em uma pasta, com o URL do ponto de extremidade, cabeçalhos necessários e resposta de exemplo.

Recupera as conexões em uma pasta.

Ponto de Extremidade da API

GET BaseURL/v1/Connections

• Use o URL base da API do Connections para a plataforma de nuvem em que você está.

Cabeçalhos de solicitação.

Cabeçalho	Valor
Autorização	O portador <your-access-token>
IdDaConta-X-UIPATH	<tenant>
ChaveDaPastaX-UIPATH	A chave da pasta que contém as conexões

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

O <your-access-token> é aquele que você recebeu quando autorizou o aplicativo externo. Ele estará disponível por 1 hora. Depois, você precisa gerar um novo ou solicitar um token de atualização. Consulte Acesso à API para saber como registrar um aplicativo externo e obter esse token.

Importante:

Os aplicativos externos devem ter como destino uma única pasta, identificada pelo cabeçalho X-UIPATH-FolderKey . Uma solicitação que omite o cabeçalho ou que define allFolders como true, retorna 400 Bad Request.

Parâmetros de Consulta

Parâmetro de consulta	Tipo de dados	Description	Valor padrão
Todas as pastas	boolean	Não é compatível com aplicativos externos. Configurá-lo como true retorna 400 Bad Request.	false

Resposta

200 OK

Retorna as conexões na pasta solicitada. As respostas para um aplicativo externo excluem o proprietário da conexão, o ID da instância do elemento, o intervalo de pesquisa e o sinalizador de traga-seu-próprio-aplicativo.

[
  {
    "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

A solicitação não forneceu o cabeçalho X-UIPATH-FolderKey ou definiu allFolders como true. Os aplicativos externos devem segmentar uma pasta por solicitação.

401 não autorizado

O token de acesso está ausente, expirou ou é inválido.

403 Forbidden

O aplicativo externo não contém o escopo necessário ou não tem a permissão Connections.View na pasta solicitada.