List installations

Authorizations

X-Api-Key

string

headerrequired

Path Parameters

projectIdOrName

string

required

integrationId

string

required

Query Parameters

groupRef

string

Response

200 - application/json

string

required

The installation ID.

projectId

string

required

The Ampersand project ID.

integrationId

string

required

The integration ID.

group

object

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.createTime

string

required

The time the connection was created.

connection.providerWorkspaceRef

string

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

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

connection.updateTime

string

The time the connection was last updated.

connection.authScheme

enum<string>

The authentication scheme used for this connection.

Available options:

none,

apiKey,

basic,

oauth2/authorizationCode,

oauth2/authorizationCodePKCE,

oauth2/clientCredentials,

oauth2/password

connection.status

enum<string>

The status of the connection.

Available options:

created,

working,

bad_credentials

connection.oauth2AuthorizationCode

object

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}".

updateTime

string

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

config

object

required

Authentication

WRITE API

READ API

PLATFORM API

List installations

Authorizations

Path Parameters

Query Parameters

Response