Skip to main content
GET
/
projects
/
{projectIdOrName}
/
integrations
/
{integrationId}
/
revisions
/
{revisionId}
:hydrate
Hydrate a revision
curl --request GET \
  --url https://api.withampersand.com/v1/projects/{projectIdOrName}/integrations/{integrationId}/revisions/{revisionId}:hydrate \
  --header 'X-Api-Key: <api-key>'
{
  "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>",
          "displayName": "<string>",
          "destination": "<string>",
          "schedule": "<string>",
          "error": "Failed to fetch fields from provider",
          "mapToName": "people",
          "mapToDisplayName": "People",
          "requiredFields": [
            {
              "fieldName": "<string>",
              "displayName": "<string>",
              "mapToName": "account_id",
              "mapToDisplayName": "Account ID"
            }
          ],
          "optionalFields": [
            {
              "fieldName": "<string>",
              "displayName": "<string>",
              "mapToName": "account_id",
              "mapToDisplayName": "Account ID"
            }
          ],
          "allFieldsMetadata": {},
          "allFields": [
            {
              "fieldName": "<string>",
              "displayName": "<string>",
              "mapToName": "account_id",
              "mapToDisplayName": "Account ID"
            }
          ],
          "backfill": {
            "defaultPeriod": {
              "days": 30,
              "fullHistory": false
            }
          }
        }
      ]
    },
    "write": {
      "objects": [
        {
          "objectName": "<string>",
          "displayName": "<string>",
          "valueDefaults": {
            "allowAnyFields": true
          }
        }
      ]
    },
    "proxy": {
      "enabled": true,
      "useModule": true
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://ampersand-24eb5c1a-cobalt0s-google-contacts.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-Api-Key
string
header
required

Path Parameters

​
projectIdOrName
string
required

The Ampersand project ID or project name.

​
integrationId
string
required

The integration ID.

​
revisionId
string
required

The revision ID.

Query Parameters

​
connectionId
string
required

The connection ID.

Response

Hydrated revision

​
id
string
required

The revision ID.

Example:

"revision-id-1"

​
specVersion
string
required

The spec version string.

Example:

"1.0.0"

​
createTime
string<date-time>
required

The time the revision was created.

​
content
Hydrated Integration · object
required