Integrations API contract

Complete HTTP contract for connector records, setup checks, stats, sync creation, and sync status.

Updated: Apr 26, 2026

Use this contract when you need exact endpoint paths, methods, parameters, request bodies, responses, schemas, and status codes.

Public contract file: /swagger/integrations-api.json

Use the operation pages for implementation guidance and this contract file for exact HTTP details.

Operation identity

When an operation page says the OpenAPI contract does not document an Operation ID, cite the stable operation key instead. Stable operation keys use the API, HTTP method, and path, so they identify an endpoint without pretending the contract publishes an operationId.

Registered routes

Use this API-first route list when you already know the owning API and need to find the exact operation page. Routes are grouped by resource so Management, Shopper, Auth, DAM, and Integrations operations stay distinct.

Integrations

GET /v1/apps/\{app_id\}/integrations - List integrations
POST /v1/apps/\{app_id\}/integrations - Create integration
GET /v1/apps/\{app_id\}/integrations/\{integration_id\} - Get integration
DELETE /v1/apps/\{app_id\}/integrations/\{integration_id\} - Delete integration
PATCH /v1/apps/\{app_id\}/integrations/\{integration_id\} - Update integration
GET /v1/apps/\{app_id\}/integrations/\{integration_id\}/stats - Get integration stats
POST /v1/apps/\{app_id\}/integrations/\{integration_id\}/sync - Create sync job
GET /v1/apps/\{app_id\}/integrations/\{integration_id\}/sync/\{sync_id\} - Get sync job status
DELETE /v1/apps/\{app_id\}/integrations/\{integration_id\}/sync/\{sync_id\} - Stop sync job
POST /v1/apps/\{app_id\}/integrations/\{integration_id\}/verify - Verify integration setup
GET /v1/apps/\{app_id\}/stats - Get app stats

Integrations API contract

# Integrations API contract Use this contract when you need exact endpoint paths, methods, parameters, request bodies, responses, schemas, and status codes. - Public contract file: /swagger/integrations-api.json Use the operation pages for implementation guidance and this contract file for exact HTTP details. ## Operation identity When an operation page says the OpenAPI contract does not document an Operation ID, cite the stable operation key instead. Stable operation keys use the API, HTTP method, and path, so they identify an endpoint without pretending the contract publishes an operationId. ## Registered routes Use this API-first route list when you already know the owning API and need to find the exact operation page. Routes are grouped by resource so Management, Shopper, Auth, DAM, and Integrations operations stay distinct. ### Integrations - GET /v1/apps/{app_id}/integrations - [List integrations](/reference/integrations/list-integrations) - POST /v1/apps/{app_id}/integrations - [Create integration](/reference/integrations/create-integration) - GET /v1/apps/{app_id}/integrations/{integration_id} - [Get integration](/reference/integrations/get-integration) - DELETE /v1/apps/{app_id}/integrations/{integration_id} - [Delete integration](/reference/integrations/delete-integration) - PATCH /v1/apps/{app_id}/integrations/{integration_id} - [Update integration](/reference/integrations/update-integration) - GET /v1/apps/{app_id}/integrations/{integration_id}/stats - [Get integration stats](/reference/integrations/get-integration-stats) - POST /v1/apps/{app_id}/integrations/{integration_id}/sync - [Create sync job](/reference/integrations/create-sync-job) - GET /v1/apps/{app_id}/integrations/{integration_id}/sync/{sync_id} - [Get sync job status](/reference/integrations/get-sync-job-status) - DELETE /v1/apps/{app_id}/integrations/{integration_id}/sync/{sync_id} - [Stop sync job](/reference/integrations/stop-sync-job) - POST /v1/apps/{app_id}/integrations/{integration_id}/verify - [Verify integration setup](/reference/integrations/verify-integration-setup) - GET /v1/apps/{app_id}/stats - [Get app stats](/reference/integrations/get-app-stats)