Get an installation

Authorizations

X-Api-Key

string

headerrequired

Path Parameters

projectIdOrName

string

required

integrationId

string

required

installationId

string

required

Response

200 - application/json

string

required

The installation ID.

projectId

string

required

The Ampersand project ID.

integrationId

string

required

The integration ID.

healthStatus

string

required

The health status of the installation ("healthy", "unhealthy").

connection

object

required

connection.id

string

required

The connection ID.

connection.projectId

string

required

The Ampersand project ID.

connection.providerApp

object

required

connection.group

object

required

connection.consumer

object

required

connection.providerWorkspaceRef

string

required

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

connection.createTime

string

required

The time the connection was created.

connection.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)

connection.updateTime

string

The time the connection was last updated.

createTime

string

required

The time the integration was first installed.

createdBy

string

required

The person who did the installation, in the format of "consumer:{consumer-id}".

config

object

required

group

object

updateTime

string

The time the installation was last updated with a new config.

Authentication

WRITE API

READ API

PLATFORM API

Get an installation

Authorizations

Path Parameters

Response