GET
/
projects
/
{projectIdOrName}
/
connections

Authorizations

X-Api-Key
string
headerrequired

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.

providerApp
object
required
group
object
required
consumer
object
required
providerWorkspaceRef
string
required

The identifier for the provider workspace (e.g. "salesforce-instance-domain")

ProviderConsumerRef
string

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)

createTime
string
required

The time the connection was created.

updateTime
string

The time the connection was last updated.

Was this page helpful?

Update an API keyGenerate a new connection (only valid for providers with auth types which are not OAuth2 Authorization Code)