---
title: "Request a Sync"
method: POST
path: "/v2/integrations/connections/{connection_id}/sync"
tags: ["integrations"]
---

# Request a Sync

`POST /v2/integrations/connections/{connection_id}/sync`

## Request

- Base URL: `https://api.stuut.ai` (the document declares no server; this is the origin it was published from)
- URL: `https://api.stuut.ai/v2/integrations/connections/{connection_id}/sync`
- Auth: HTTP bearer

Request a data sync for an integration connection.

## Path parameters

- `connection_id` string, required

## Response `200`

Successful Response

- IntegrationConnectionModelSync[]
  - `created_at` string, date-time, required
  - `modified_at` string, date-time, nullable, required
  - `id` string, required
  - `status` 'scheduled' | 'queued' | 'running' | 'cancelled' | 'failed' | 'pending_retry' | 'complete', required
  - `attempt` integer, required: Number of attempts made to run this sync. 0 means no attempts have been made.
  - `batch_id` string, uuid, nullable, required
  - `completed_at` string, date-time, required
  - `entity_id` string, nullable, required
  - `error` string, nullable, required: Error message if the sync failed.
  - `file_id` string, nullable, required
  - `is_initial_sync` boolean, required
  - `is_one_off` boolean, required: Whether or not this is a one off sync
  - `model_id` string, required
  - `pagination_state` object, nullable, required
  - `started_at` string, date-time, required
  - `timerange_end` string, date-time, required
  - `timerange_start` string, date-time, required
  - `object` string, required: String representing the object's type. Objects of the same type share the same value.

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/stuut/apis/stuut-api.md) - [All operations](https://skmtc.dev/stuut/apis/stuut-api/llms.txt) - [OpenAPI document](https://skmtc.dev/stuut/apis/stuut-api/revisions/3b5ab941f918?raw)