API referenceAPIAvailable

Integrations

Manage source-to-destination data flows in Vendo.

Last reviewed July 13, 2026

Integrations connect a source app to a destination app and define what data is sent, on what schedule, and with what task configuration.

List Integrations


GET /api/v1/integrations

Query Parameters

Parameter	Type	Description
`limit`	integer	Number of items to return
`offset`	integer	Number of items to skip
`sort`	string	Sort by `created_at`, `updated_at`, or `last_sync_at`
`state`	string	Filter by `active`, `inactive`, `deleted`
`status`	string	Filter by `pending`, `running`, `completed`, `errored`, `paused`, `draft`
`source_app_id`	string	Filter by source app
`destination_app_id`	string	Filter by destination app
`data_type`	string	Filter by data type

Example Response


{
  "data": [
    {
      "id": "int_123",
      "accountId": "acct_123",
      "sourceAppId": "app_source_123",
      "sourceAppName": "Shopify",
      "sourceAppType": "shopify",
      "destinationAppId": "app_destination_123",
      "destinationAppName": "Mixpanel Production",
      "destinationAppType": "mixpanel",
      "dataType": "events",
      "config": {
        "global": {},
        "tasks": [{ "task_type": "track_events" }]
      },
      "schedule": {
        "frequencyValue": 1,
        "frequencyUnit": "hours",
        "rollingWindowDays": 7
      },
      "state": "active",
      "status": "running",
      "isActive": true,
      "lastSyncAt": "2026-04-02T00:00:00Z",
      "lastError": null,
      "consecutiveFailures": 0,
      "importDependencyStatus": "ready",
      "latestJobId": "job_123",
      "createdAt": "2026-04-01T00:00:00Z",
      "updatedAt": "2026-04-02T00:00:00Z"
    }
  ]
}

Get Integration Details


GET /api/v1/integrations/{integrationId}

Detail responses include richer source/destination app objects, import dependency state, historical sync start date, and triggered import job IDs.

Create Integration


POST /api/v1/integrations

Required Fields

Field	Type	Description
`destinationAppId`	string	Destination-role app connection
`dataType`	string	Data type to sync
`config`	object	Must include at least one task
`schedule`	object	Integration schedule

Optional Fields

Field	Type	Description
`sourceAppId`	string	Source-role app connection
`historicalSyncStartDate`	datetime	Backfill start

Update Integration


PATCH /api/v1/integrations/{integrationId}

Supported updates:

config
schedule
isActive

isActive=false pauses the integration. isActive=true resumes it using the integration lifecycle rules enforced by Vendo.

Delete Integration


DELETE /api/v1/integrations/{integrationId}

Integrations are soft-deleted.