---
title: "GET /v1/code/syncs/{id}"
method: GET
path: "/v1/code/syncs/{id}"
tags: ["code"]
---

# GET /v1/code/syncs/{id}

`GET /v1/code/syncs/{id}`

## Request

- Base URL: `https://help.steep.app` (the document declares no server; this is the origin it was published from)
- URL: `https://help.steep.app/v1/code/syncs/{id}`
- Auth: none declared

Get the current state of a sync by `id`. Use to poll an enqueued sync until its `outcome` is terminal (`completed` or `failed`).

## Path parameters

- `id` string, required

## Response `200`

Response for status 200

- union
  - object
    - `id` string, required: Unique resource ID (opaque).
    - `workspaceId` unknown, required
    - `datasourceId` string, required: Unique resource ID (opaque).
    - `method` string, required: How the sync was triggered.
    - `outcome` 'queued' | 'running' | 'completed' | 'failed', required: Lifecycle state. `queued` and `running` are in-progress; `completed` and `failed` are terminal. Poll until terminal with `get sync by id`.
    - `createdAt` string, date-time, required
    - `created` string[], required: `identifier`s of entities the sync created. Null until terminal.
    - `updated` string[], required: `identifier`s of entities the sync updated. Null until terminal.
    - `removed` string[], required: `identifier`s of entities the sync removed. Null until terminal.
    - `unchanged` string[], required: `identifier`s of entities the sync left unchanged. Null until terminal.
    - `error` unknown, required
    - `type` string, required: Source of the semantic models that were synced.
    - `errors` string[], required: Errors the sync reported. Null until terminal.
    - `warnings` string[], required: Warnings the sync reported. Null until terminal.
  - object
    - `id` string, required: Unique resource ID (opaque).
    - `workspaceId` unknown, required
    - `datasourceId` string, required: Unique resource ID (opaque).
    - `method` string, required: How the sync was triggered.
    - `outcome` 'queued' | 'running' | 'completed' | 'failed', required: Lifecycle state. `queued` and `running` are in-progress; `completed` and `failed` are terminal. Poll until terminal with `get sync by id`.
    - `createdAt` string, date-time, required
    - `created` string[], required: `identifier`s of entities the sync created. Null until terminal.
    - `updated` string[], required: `identifier`s of entities the sync updated. Null until terminal.
    - `removed` string[], required: `identifier`s of entities the sync removed. Null until terminal.
    - `unchanged` string[], required: `identifier`s of entities the sync left unchanged. Null until terminal.
    - `error` unknown, required
    - `type` 'dbt Core' | 'dbt Cloud' | 'Cube', required: Source of the semantic models that were synced.
    - `errors` object, required: Errors keyed by metric `identifier`. Null until terminal.
    - `warnings` object, required: Warnings keyed by metric `identifier`. Null until terminal.

## Other responses

- `401`: Response for status 401
- `403`: Response for status 403
- `422`: Response for status 422
- `429`: Response for status 429
- `500`: Response for status 500

---

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