Developer APIResourcesConnections

List connections

Returns all connections and associated data for the authenticated Workato user.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

providerstringOptional

Connector identifier. For example: salesforce.

folder_idstringOptional
Folder ID where the connections is stored.
parent_idstringOptional
ID of parent connection to get all children. Connection must be of the same provider.
external_idstringOptional
External identifier usually given to the user who owns the connection.
include_runtime_connectionsstringOptional

Flag to define either include or not runtime connections. set to set to true, all runtime user connections are returned. Default: false.

Response

Success reply
applicationstring or null
The name of the application associated with the connection.
idinteger or null
The unique identifier for the connection.
namestring or null
The name of the connection.
descriptionstring or null
The description of the connection, if any.
authorized_atstring or null
The timestamp when the connection was authorized.
authorization_statusstring or null
The status of the connection authorization.
authorization_errorstring or null
Details of any authorization errors, if applicable.
created_atstring or null
The timestamp when the connection was created.
updated_atstring or null
The timestamp when the connection was last updated.
external_idstring or null
The external ID associated with the connection, if any.
folder_idinteger or null
The ID of the folder containing the connection.
connection_lost_atstring or null
The timestamp when the connection was lost, if applicable.
connection_lost_reasonstring or null
The reason why the connection was lost, if applicable.
parent_idinteger or null
The ID of the parent connection, if applicable.
tagslist of strings or null
Tags associated with the connection.

Errors