Embedded APIResourcesConnections

List connections

Retrieves all connections and associated data for the Embedded customer account. Requires oem_vendor privilege.

Path parameters

managed_user_idstringRequired

Embedded customer ID (external ID). The External ID must be URL encoded and prefixed with an E. For example, EA2300.

Headers

AuthorizationstringRequired

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

Query parameters

providerstringOptional

The application type of the connection, for example, salesforce.

folder_idstringOptional
The ID of the project or folder containing the connection.
parent_idstringOptional
The ID of the parent connection, which must be of the same provider type.
external_idstringOptional
The external ID assigned to the connection, typically given to the user who owns the connection.
include_runtime_connectionsstringOptional

Includes all runtime user connections when set to true.

includesstringOptional

Specifies additional fields to include in the response. Accepts tags as a value. If tags is supplied in the request, the response includes a tags field for each connection. This field contains an array of zero or more tag handles (strings).

Response

Success reply
resultlist of objects

Errors