Authentication
WRITE API
- Write
- Upload URL
READ API
- Read
PLATFORM API
- OAuth
- Project
- Provider App
- Integration
- Revision
- Installation
- Operation
- Provider
- API Key
- Connection
- Group
- Consumer
- Destination
- Upload URL
- Org
- User
- Billing Account
Import an existing installation
The SaaS provider that this installation connects to.
ID of the provider app (e.g. Salesforce connected app), returned from a CreateProviderApp call. If omitted, the default provider app that was set up on the Ampersand Dashboard is assumed.
The ID of the user group that has access to this installation. This is any ID that your app uses to identify a group of users - such as an org, team, or workspace.
The display name of the user group that has access to this installation.
The ID of the user whose credential was used for this connection. This is the ID that your app uses to identify a user - such as a user ID or username.
The display name of the user whose credential was used for this connection.
The identifier for the provider workspace (e.g. the Salesforce subdomain)
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)
The refresh token.
The OAuth scopes for this token. If omitted, will default to the scopes of the Provider App.
The config of the installation.
The ID of the integration revision that this config is based on. If omitted, the latest revision is assumed.
The SaaS API that we are integrating with.
This is a map of object names to their configuration.
This is a map of object names to their configuration.
Authorizations
Body
The SaaS provider that this installation connects to.
The ID of the user group that has access to this installation. This is any ID that your app uses to identify a group of users - such as an org, team, or workspace.
The display name of the user group that has access to this installation.
The ID of the user whose credential was used for this connection. This is the ID that your app uses to identify a user - such as a user ID or username.
The display name of the user whose credential was used for this connection.
The identifier for the provider workspace (e.g. the Salesforce subdomain)
The refresh token.
ID of the provider app (e.g. Salesforce connected app), returned from a CreateProviderApp call. If omitted, the default provider app that was set up on the Ampersand Dashboard is assumed.
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)
The OAuth scopes for this token. If omitted, will default to the scopes of the Provider App.
The config of the installation.
The SaaS API that we are integrating with.
The ID of the integration revision that this config is based on. If omitted, the latest revision is assumed.
Response
The installation ID.
The Ampersand project ID.
The integration ID.
The health status of the installation ("healthy", "unhealthy").
The connection ID.
The Ampersand project ID.
The provider app ID.
The Ampersand project ID.
The SaaS provider that this app connects to.
The OAuth client ID for this app.
The time the provider app was created.
The ID used by the provider to identify the app (optional).
The OAuth scopes for this app.
The time the provider app was updated.
The ID of the user group that has access to this installation.
The name of the user group that has access to this installation.
The Ampersand project ID.
The time the group was created.
The time the group was last updated.
The consumer reference.
The name of the consumer.
The Ampersand project ID.
The time the consumer was created.
The time the consumer was last updated.
The identifier for the provider workspace (e.g. "salesforce-instance-domain")
The time the connection was created.
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)
The time the connection was last updated.
The time the integration was first installed.
The person who did the installation, in the format of "consumer:{consumer-id}".
The config ID.
The ID of the revision that this config is based on.
The time the config was created.
The person who created the config, in the format of "consumer:{consumer-id}" or "builder:{builder-id}".
The SaaS API that we are integrating with.
The ID of the user group that has access to this installation.
The name of the user group that has access to this installation.
The Ampersand project ID.
The time the group was created.
The time the group was last updated.
The time the installation was last updated with a new config.
Was this page helpful?