---
title: "Get sync"
method: GET
path: "/syncs/{syncid}"
tags: ["Syncs"]
---

# Get sync

`GET /syncs/{syncid}`

Returns a sync by id

## Path parameters

- `syncid` string, required

## Response `200`

Successful Response

- ReadSyncItem
  - `name` string, required
  - `config` object, nullable
  - `connections` SyncsConnectionItem[], required
    - `one_api` integer, nullable
    - `connection_type` integer, nullable
    - `display_order` integer
    - `display_hidden` boolean
  - `mappings` CreateSyncMappingItemOutput[]
    - `name` string, required
    - `description` string, nullable
    - `display_order` integer
    - `challenge_question` string, nullable
    - `conditions` object, nullable
    - `sub_mappings` CreateSyncMappingToFieldItemOutput[]
      - `name` string, required
      - `description` string, nullable
      - `display_order` integer
      - `challenge_question` string, nullable
      - `conditions` object, nullable
      - `source_field` FieldItem, required
        - `name` string, required
        - `type` 'fixed' | 'api', required
        - `display_condition` object, nullable
        - `values` FieldItemValue[], nullable
          - `id` string, required
          - `label` string, required
        - `api_route` string, nullable
        - `connection_type` integer, nullable
      - `target_field` FieldItem, required
        - `name` string, required
        - `type` 'fixed' | 'api', required
        - `display_condition` object, nullable
        - `values` FieldItemValue[], nullable
          - `id` string, required
          - `label` string, required
        - `api_route` string, nullable
        - `connection_type` integer, nullable
      - `display_delete` boolean
      - `logic` object, nullable
  - `syncid` string, uuid, required
  - `consumers` string[], required
  - `flows` ReadFlowItem[], required
    - `name` string, required
    - `description` string, nullable
    - `id` string, required
    - `execution` FlowExecution
      - `type` 'code' | 'module', required
      - `data` union, required
        - FlowExecutionChain
          - `name` string, required
        - FlowExecutionCode
          - `code` string, required
    - `config` FlowConfigOutput
      - `definitionFields` object[], nullable
      - `doorkeyFields` object[], nullable
      - `customFields` object[], nullable
      - `datastores` FlowDataStoreItemOutput[], nullable
        - `id` string, nullable
        - `name` string, required
        - `status` 'active' | 'inactive'
        - `definition` DatastoreDef, required
          - `columns` DatastoreColumn[], required
            - `name` string, required
            - `title` string, required
            - `type` string, required
            - `optional` boolean, nullable
          - `search_column` string, nullable — Column name that will be indexed and used in search if any.
    - `triggers` FlowTrigger[], nullable
      - `id` string, required
      - `type` 'timer' | 'event', required
      - `cronschedules` string[], nullable
      - `visible` boolean, nullable
      - `definitionFields` object[], nullable
      - `options` object, nullable
      - `priority` 'NORMAL' | 'MEDIUM' | 'HIGH'

## Other responses

- `404` — Not Found
- `422` — Validation Error

---

[API](https://skmtc.net/chift/apis/chift-api.md) · [All operations](https://skmtc.net/chift/apis/chift-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/chift/chift-api/revisions/b5f1214a482a/schema)