Skip to main content
GET
/
projects
/
{projectIdOrName}
/
integrations
/
{integrationIdOrName}
Get an integration by ID or name
curl --request GET \
  --url https://api.withampersand.com/v1/projects/{projectIdOrName}/integrations/{integrationIdOrName} \
  --header 'X-Api-Key: <api-key>'
{
  "id": "<string>",
  "projectId": "project-456",
  "name": "read-accounts",
  "provider": "salesforce",
  "createTime": "2023-11-07T05:31:56Z",
  "updateTime": "2023-11-07T05:31:56Z",
  "latestRevision": {
    "id": "revision-id-1",
    "specVersion": "1.0.0",
    "createTime": "2023-11-07T05:31:56Z",
    "content": {
      "name": "<string>",
      "provider": "<string>",
      "displayName": "<string>",
      "module": "<string>",
      "read": {
        "objects": [
          {
            "objectName": "<string>",
            "destination": "<string>",
            "schedule": "<string>",
            "mapToName": "people",
            "mapToDisplayName": "People",
            "requiredFields": [
              {
                "fieldName": "<string>",
                "mapToName": "account_id",
                "mapToDisplayName": "Account ID"
              }
            ],
            "optionalFields": [
              {
                "fieldName": "<string>",
                "mapToName": "account_id",
                "mapToDisplayName": "Account ID"
              }
            ],
            "optionalFieldsAuto": "all",
            "backfill": {
              "defaultPeriod": {
                "days": 30,
                "fullHistory": false
              }
            },
            "delivery": {
              "mode": "auto",
              "pageSize": 275
            },
            "enabled": "always"
          }
        ]
      },
      "write": {
        "objects": [
          {
            "objectName": "<string>",
            "inheritMapping": true,
            "valueDefaults": {
              "allowAnyFields": true
            }
          }
        ]
      },
      "proxy": {
        "enabled": true,
        "useModule": true
      },
      "subscribe": {
        "objects": [
          {
            "objectName": "<string>",
            "destination": "<string>",
            "inheritFieldsAndMapping": true,
            "createEvent": {
              "enabled": "always"
            },
            "updateEvent": {
              "enabled": "always",
              "watchFieldsAuto": "all",
              "requiredWatchFields": [
                [
                  "name",
                  "domain"
                ]
              ]
            },
            "deleteEvent": {
              "enabled": "always"
            },
            "associationChangeEvent": {
              "enabled": "always",
              "includeFullRecords": true
            },
            "otherEvents": [
              [
                "object.merged",
                "object.restored"
              ]
            ]
          }
        ]
      }
    }
  }
}

Authorizations

X-Api-Key
string
header
required

Path Parameters

integrationIdOrName
string
required

The integration ID or name.

projectIdOrName
string
required

The Ampersand project ID or project name.

Response

The integration

id
string
required

The integration ID.

projectId
string
required

The Ampersand project ID.

Example:

"project-456"

name
string
required

The integration name.

Example:

"read-accounts"

provider
string
required

The SaaS provider that this integration connects to.

Example:

"salesforce"

createTime
string<date-time>
required

The time the integration was created.

latestRevision
object
required
updateTime
string<date-time>

The time the integration was last updated.