Skip to main content
GET
/
projects
/
{projectIdOrName}
/
integrations
/
{integrationId}
/
installations
/
{installationId}
/
operations
List operations
curl --request GET \
  --url https://api.withampersand.com/v1/projects/{projectIdOrName}/integrations/{integrationId}/installations/{installationId}/operations \
  --header 'X-Api-Key: <api-key>'
{
  "results": [
    {
      "projectId": "123e4567-e89b-12d3-a456-426614174000",
      "integrationId": "<string>",
      "configId": "a1b2c3d4-e5f6-4789-a012-3456789abcde",
      "actionType": "read",
      "id": "<string>",
      "installationId": "<string>",
      "status": "success",
      "result": "[contact] No new data found",
      "metadata": {
        "objects": [
          "contact"
        ],
        "progress": {
          "installationId": "66438162-5299-4669-a41d-85c5a3b1a83e",
          "objectName": "contact",
          "operationId": "3efc0f0f-4bb9-498f-996c-9893d98ca4b5",
          "recordsProcessed": 1250,
          "recordsEstimatedTotal": 5000
        }
      },
      "createTime": "2023-07-13T21:34:44.816354Z"
    }
  ],
  "pagination": {
    "done": false,
    "nextPageToken": "Q9JT+2qfys28V4ODN+UayA=="
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.withampersand.com/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.

​
installationId
string
required

The Ampersand installation ID.

Query Parameters

​
pageSize
integer
default:200

The number of operations to return.

Required range: 1 <= x <= 1000
​
pageToken
string

A cursor that can be passed to paginate through multiple pages of operations.

Response

List of operations

​
results
Operation · object[]
required
​
pagination
Pagination Information · object
required