---
title: "Get sync information for one consumer"
method: GET
path: "/consumers/{consumer_id}/syncs/{syncid}"
tags: ["Consumers"]
---

# Get sync information for one consumer

`GET /consumers/{consumer_id}/syncs/{syncid}`

Returns sync information (creation date, mapping) related to a specific consumer

## Path parameters

- `consumer_id` string, uuid, required
- `syncid` string, uuid, required

## Query parameters

- `preview_executionid` string, uuid, nullable

## Response `200`

Successful Response

- SyncConsumerItem
  - `syncid` string, uuid, required
  - `sync_name` string, required — Name of the sync
  - `status` 'active' | 'inactive'
  - `status_details` string, nullable — Gives additional information if the status is inactive
  - `link_createdon` string, date-time, required — Date on which the consumer first navigated to the link to setup the sync
  - `link_mappings` ReadSyncMappingItem[], nullable — Values of the mappings requested for the sync for the specific consumer
    - `name` string, required
    - `description` string, nullable
    - `display_order` integer
    - `challenge_question` string, nullable
    - `conditions` object, nullable
    - `values` ReadMappingItem[], required
      - `source_id` string, nullable
      - `target_id` string, nullable
    - `hidden_source_ids` string[], required
    - `sub_mapping_name` string, required
    - `sub_mapping_description` string, nullable
  - `skip_mappings` ReadSyncSkipMappingItem[], nullable — List of mappings which are ignored due to specific configuration of the consumer
    - `name` string, required
    - `skip_reason` 'presync' | 'connector_feature' | 'challenge', required
  - `link_metadata` object, nullable — Metadata passed during creation
  - `link_presync` object, nullable — Values of the presync configuration for the sync for the specific consumer
  - `enabled_flows` ReadFlowConsumerItem[], nullable — List of flows that the consumer has enabled
    - `name` string, required
    - `description` string, nullable
    - `id` 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.
    - `values` object, required
    - `enabled_on` string, date-time, nullable — Date on which the flow was enabled for this consumer
    - `trigger` ReadFlowTrigger, required
      - `id` string, required
      - `type` 'timer' | 'event', required
      - `cronschedule` string, nullable

## 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)