> Source: https://wexa.ai/docs/connectors/get-connector-sync

# get-connector-sync

Read the status of a connector sync that [`sync-connector`](/docs/connectors/sync-connector) started or joined. `status` says whether the refresh succeeded and `ingestion` says what is known about the data, so `succeeded` does not mean the data is in. Needs the `fabric:orchestrate.read` grant.

**Follow a sync**

**Wexa MCP server**

```bash
curl -sS -X POST https://fabric.wexa.ai/mcp/$FABRIC_PROJECT_ID \
  -H "authorization: Bearer $FABRIC_API_KEY" \
  -H "Mcp-Session-Id: $MCP_SESSION_ID" \
  -H "content-type: application/json" -H "accept: application/json" \
  -d '{"jsonrpc":"2.0","id":3,"method":"tools/call","params":{"name":"get-connector-sync","arguments":{"sync_id":"connector-sync-6aa9beb7ec8121a43b6c791b-6ab3608bf19beb4f0ed39e77-1790280549835063253"}}}'
```

```json
{
  "content": [
    {
      "type": "text",
      "text": "{\"lifecycle_id\":\"qlc_000010\",\"result\":{\"sync_id\":\"connector-sync-6aa9beb7ec8121a43b6c791b-6ab3608bf19beb4f0ed39e77-1790280549835063253\",\"connector_id\":\"6ab3608bf19beb4f0ed39e77\",\"status\":\"succeeded\",\"ingestion\":\"running\",\"actions_synced\":17}}"
    }
  ],
  "isError": false
}
```

**REST API**

```bash
curl -sS https://fabric.wexa.ai/v1/get-connector-sync \
  -H "authorization: Bearer $FABRIC_API_KEY" \
  -H "content-type: application/json" \
  -d '{"sync_id":"connector-sync-6aa9beb7ec8121a43b6c791b-6ab3608bf19beb4f0ed39e77-1790280549835063253"}'
```

```json
{
  "lifecycle_id": "qlc_000010",
  "result": {
    "sync_id": "connector-sync-6aa9beb7ec8121a43b6c791b-6ab3608bf19beb4f0ed39e77-1790280549835063253",
    "connector_id": "6ab3608bf19beb4f0ed39e77",
    "status": "succeeded",
    "ingestion": "running",
    "actions_synced": 17
  }
}
```

**TypeScript SDK**

```ts
import { Fabric } from '@wexa-fabric/sdk'

const fabric = new Fabric()
const result = await fabric.getConnectorSync({
  sync_id: 'connector-sync-6aa9beb7ec8121a43b6c791b-6ab3608bf19beb4f0ed39e77-1790280549835063253'
})
```

```ts
// result is the payload itself, with no `.result` to read
{
  sync_id: 'connector-sync-6aa9beb7ec8121a43b6c791b-6ab3608bf19beb4f0ed39e77-1790280549835063253',
  connector_id: '6ab3608bf19beb4f0ed39e77',
  status: 'succeeded',
  ingestion: 'running',
  actions_synced: 17
}
```

**Python SDK**

```python
from wexa import Fabric

fabric = Fabric()
out = fabric.get_connector_sync(
    sync_id="connector-sync-6aa9beb7ec8121a43b6c791b-6ab3608bf19beb4f0ed39e77-1790280549835063253",
)
```

```python
# out is the result, already unwrapped
{
    "sync_id": "connector-sync-6aa9beb7ec8121a43b6c791b-6ab3608bf19beb4f0ed39e77-1790280549835063253",
    "connector_id": "6ab3608bf19beb4f0ed39e77",
    "status": "succeeded",
    "ingestion": "running",
    "actions_synced": 17
}
```

## Parameters

| Parameter | Type | Required | Notes |
| --- | --- | --- | --- |
| `sync_id` | string | Required | The `sync_id` that `sync-connector` returned. A string. One from another project, or for a connector you cannot sync, is refused (403) before the platform is asked. An unknown one is refused (404). |

**Show full response**

- `sync_id`: the sync you asked about.
- `connector_id`: the connector being synced.
- `status`: `running`, `succeeded` or `failed`, as described in More details.
- `ingestion`: `not_started`, `started`, `running`, `ingested` or `not_supported`, as described in More details.
- `actions_synced`: how many of the connector's actions the refresh synced.
- `error`: present only when `status` is `failed`.

A real response, captured from a live call to `get-connector-sync` after a sync of a Linear connector ended. The
refresh succeeded and synced 17 actions, and its data was still moving. Nothing is changed.

**Result of get-connector-sync**

**REST API**

```json
{
  "lifecycle_id": "qlc_000010",
  "result": {
    "sync_id": "connector-sync-6aa9beb7ec8121a43b6c791b-6ab3608bf19beb4f0ed39e77-1790280549835063253",
    "connector_id": "6ab3608bf19beb4f0ed39e77",
    "status": "succeeded",
    "ingestion": "running",
    "actions_synced": 17
  }
}
```

**Wexa MCP server**

```json
{
  "content": [
    {
      "type": "text",
      "text": "{\"lifecycle_id\":\"qlc_000010\",\"result\":{\"sync_id\":\"connector-sync-6aa9beb7ec8121a43b6c791b-6ab3608bf19beb4f0ed39e77-1790280549835063253\",\"connector_id\":\"6ab3608bf19beb4f0ed39e77\",\"status\":\"succeeded\",\"ingestion\":\"running\",\"actions_synced\":17}}"
    }
  ],
  "isError": false
}
```

**TypeScript SDK**

```ts
// the object you get back IS the result — there is no `.result` to read
{
  "sync_id": "connector-sync-6aa9beb7ec8121a43b6c791b-6ab3608bf19beb4f0ed39e77-1790280549835063253",
  "connector_id": "6ab3608bf19beb4f0ed39e77",
  "status": "succeeded",
  "ingestion": "running",
  "actions_synced": 17
}

// The TS SDK names these camelCase — lifecycleId, traceId — where Python uses
// lifecycle_id and trace_id. Both are non-enumerable: readable, but omitted by
// Object.keys() and JSON.stringify(). `result.lifecycleId` here is undefined.
result.lifecycleId // 'qlc_000010'
```

**Python SDK**

```python
# a dict subclass; `result` is already unwrapped
{
 "sync_id": "connector-sync-6aa9beb7ec8121a43b6c791b-6ab3608bf19beb4f0ed39e77-1790280549835063253",
 "connector_id": "6ab3608bf19beb4f0ed39e77",
 "status": "succeeded",
 "ingestion": "running",
 "actions_synced": 17
}

out.lifecycle_id  # 'qlc_000010' — an attribute, not a key
```

**More details**

A sync does two things, and the status reports them separately, because they end at different times and one of them cannot always report its end. It refreshes the connector's actions and ontology inside Wexa, which `status` reports. It starts ingestion, when the connector has data to pull, which `ingestion` reports. Read `status: "succeeded"` as "the refresh succeeded". It does not mean that the data is in.

`status` is one of:

- `running`: the refresh is still running.
- `succeeded`: the connector's actions and ontology were refreshed.
- `failed`: the refresh failed, and `error` carries the reason the platform recorded.

A sync is `failed` when its workflow failed or ended early, when the connector failed to sync, or when the sync found no connector with that id in the project. It is never `succeeded` without having synced the connector. A failed sync is not an error: it comes back as a status with `status: "failed"`.

`ingestion` is one of:

- `not_started`: no ingestion was started yet. It stays so while the refresh runs, and when the refresh failed.
- `started`: ingestion was started, and no data is being pulled right now. A native connector also shows this after its pull ends, because the platform does not record when the pulled data has all reached the context graph.
- `running`: data is moving into the context graph.
- `ingested`: the platform recorded that ingestion finished after this sync started.
- `not_supported`: the sync started no ingestion, because the connector has no data to pull. Only its actions and ontology were refreshed.

`ingested` appears only for a data source ingested through the catalog pipeline, such as a database. A native connector, such as Linear or Slack, reports `running` while its data is pulled and `started` after the pull ends, and never reports `ingested`.

The error codes are `S8:connector-not-usable` (`ForbiddenError`) and `S8:connector-sync-not-found` (`NotFound`). Reading a status needs only `fabric:orchestrate.read`, so a key that watches syncs does not need the power to start them. Not marked consequential. See [ingestion](/docs/context/ingestion) for following a sync.

Every tool call works the same way: [How every tool call works](/docs/sdks-and-apis/how-every-tool-call-works).