Get a connection
Authorizations
Query Parameters
Whether to include the credentials in the response. Only access token will be included. Default is false.
Whether to include the refresh token in credentials in the response along with access token. If true, the includeCreds query parameter will be ignored. Default is false.
Whether to refresh the access token. If value is ifExpired, the access token will be refreshed only if it has expired. If value is force, the access token will be refreshed regardless of its expiration.
force, ifExpired Response
The connection ID.
The Ampersand project ID.
The SaaS provider that this Connection is for.
The time the connection was created.
The authentication scheme used for this connection.
none, apiKey, basic, oauth2/authorizationCode, oauth2/authorizationCodePKCE, oauth2/clientCredentials, oauth2/password The status of the connection.
created, working, bad_credentials If available, the identifier for the provider workspace (e.g. "salesforce-instance-domain")
If available, the ID that Salesforce/Hubspot uses to identify this user (e.g. Salesforce has IDs in the form of https://login.salesforce.com/id/00D4x0000019CQTEA2/0054x000000orJ4AA)
The time the connection was last updated.
The API key used while making the connection.
Was this page helpful?