GET
/
projects
/
{projectIdOrName}
/
connections
/
{connectionId}

Authorizations

X-Api-Key
string
header
required

Path Parameters

projectIdOrName
string
required
connectionId
string
required

Query Parameters

includeCreds
boolean

Whether to include the credentials in the response. Only access token will be included. Default is false.

includeRefreshToken
boolean

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.

refresh
enum<string>

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.

Available options:
force,
ifExpired

Response

200
application/json
id
string
required

The connection ID.

projectId
string
required

The Ampersand project ID.

provider
string
required

The SaaS provider that this Connection is for.

group
object
required
consumer
object
required
createTime
string
required

The time the connection was created.

authScheme
enum<string>
required

The authentication scheme used for this connection.

Available options:
none,
apiKey,
basic,
oauth2/authorizationCode,
oauth2/authorizationCodePKCE,
oauth2/clientCredentials,
oauth2/password
status
enum<string>
required

The status of the connection.

Available options:
created,
working,
bad_credentials
providerApp
object
providerWorkspaceRef
string

If available, the identifier for the provider workspace (e.g. "salesforce-instance-domain")

providerConsumerRef
string

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)

updateTime
string

The time the connection was last updated.

oauth2AuthorizationCode
object
apiKey
string

The API key used while making the connection.