Skip to navigation
AssetsData connectors

Retrieve a connection

This method retrieves details about the specified connection.

Authentication

x-api-keystring

Your API key.

Note

You can find your API key on the API Keys page.

Path parameters

connection_idstringRequired
The unique identifier of the connection to retrieve.

Response

The connection has been successfully retrieved.
_idstringOptional
The unique identifier of the connection.
providerenumOptional
The data connector provider.
Allowed values:
statusenumOptional

The status of the connection. See The connection object for the possible values.

Allowed values:
custom_idstringOptional

The label you supplied when you authorized the connection. The platform does not interpret this value, and it does not need to be unique. Multiple connections can share the same custom_id value.

accountobjectOptional
Information about the connected provider account.
scopeslist of stringsOptional
The scopes granted to the connection.
connected_atstringOptionalformat: "date-time"

The date and time, in the RFC 3339 format (“YYYY-MM-DDTHH:mm:ssZ”), when the connection was established.

last_used_atstringOptionalformat: "date-time"

The date and time, in the RFC 3339 format (“YYYY-MM-DDTHH:mm:ssZ”), when the connection was last used.

Errors

400
Bad Request Error
404
Not Found Error