Run a named provider migration for a connection
Runs a migration registered for the connection's provider as a bounded series of syncs, and reports whether it completed or stopped partway with the objects imported so far, the guarantees the migration preserves, and any warnings; a partial result means the run should be repeated to continue. Requires the `integrations:write` workspace permission, and is rejected as invalid when the migration key is not registered for the provider or the provider has no adapter. Send an `Idempotency-Key` header to make retries safe; a replay within the window returns the original response.
Authorization
apiKey Workspace API key created in Workspace settings → API keys. Scopes on the key bound what it can read and write.
In: header
Path Parameters
Response Body
application/json
application/json
application/json
curl -X POST "https://example.com/v1/workspaces/string/integrations/connections/string/migrations/string/run"{ "data": { "migrationKey": "string", "provider": "string", "status": "succeeded", "complete": true, "preserves": [ "hierarchy" ], "warnings": [ "string" ], "runs": [ { "id": "string", "workspaceId": "string", "connectionId": "string", "dataSourceId": "string", "provider": "string", "status": "running", "trigger": "string", "cursorBefore": "string", "cursorAfter": "string", "stats": {}, "error": "string", "startedAt": "string", "completedAt": "string" } ], "importedObjects": 0 }}{ "_tag": "ApiNotFound", "error": "not_found", "message": "That item does not exist, or this key cannot see it.", "status": 404}{ "_tag": "ApiNotFound", "error": "not_found", "message": "That item does not exist, or this key cannot see it.", "status": 404}Run a sync for an integration connection
Runs the provider adapter's sync once for the connection, with an optional `trigger` and `scope` to narrow what is pulled, and returns the resulting run with its statistics. Requires the `integrations:write` workspace permission; a connection whose provider has no registered adapter is rejected as invalid.
List recent sync runs in a workspace
Returns the workspace's most recent integration sync runs with their status and statistics. Requires the `integrations:read` workspace permission. Pass `connectionId` to restrict the list to one connection and `limit` to cap how many runs come back.