GET
/
projects
/
{projectIdOrName}
/
connections

Authorizations

​
X-Api-Key
string
header
required

Path Parameters

​
projectIdOrName
string
required

Query Parameters

​
provider
string

The provider name (e.g. "salesforce", "hubspot")

​
groupRef
string

The ID of the user group that has access to this installation.

​
consumerRef
string

The consumer reference.

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.

Was this page helpful?

Suggest editsRaise issue
Update an API keyGenerate a new connection