---
title: "Get Flexible Sync information"
method: GET
path: "/groups/{groupId}/apps/{appId}/service/{serviceId}/config"
tags: ["sync"]
---

# Get Flexible Sync information

`GET /groups/{groupId}/apps/{appId}/service/{serviceId}/config`

Retrieve sync data for a specific Atlas App Services App when using
[Flexible Sync](https://www.mongodb.com/docs/atlas/app-services/sync/get-started/).

## Response `200`

Successfully retrieved.

- SyncDataResponse
  - `clusterId` string — The Service ID for the linked cluster.
  - `clusterName` string — The name of the linked cluster
  - `clusterType` 'atlas' | 'serverless' — The service type of the linked cluster ("atlas" by default)
  - `flexible_sync` FlexibleSync
    - `state` string, required — The state of the sync service (`"enabled"`, `"disabled"`, or empty if Sync is not configured).
    - `database_name` string — The name of a database in the synced cluster where App Services stores data in Development Mode. App Services automatically generates a schema for each synced type and maps each object type to a collection within the database.
    - `queryable_fields_names` string[] — An array of [queryable field](https://www.mongodb.com/docs/atlas/app-services/sync/configure/sync-settings/#queryable-fields) names on **any collection**.
    - `indexed_queryable_fields_names` string[] — A list of field names to use as the [indexed queryable field](https://www.mongodb.com/docs/atlas/app-services/sync/configure/sync-settings/#queryable-fields). Although this property is an array, Sync currently supports only one indexed queryable field. Therefore, this array may contain at most one element. The indexed queryable field must be present in the schema and be the same eligible field type in every collection you sync. The indexed queryable field name must also appear in `queryable_fields_names` since this is a global queryable field.
    - `collection_queryable_fields_names` object — An array of [queryable field](https://www.mongodb.com/docs/atlas/app-services/sync/configure/sync-settings/#queryable-fields) names on the specified collection.
    - `permissions` object — **Deprecated**
    - `last_disabled` string — The last time Sync was disabled, represented by the number of seconds since the UNIX epoch.
    - `client_max_offline_days` integer — The number of days the client can be offline before a client [reset](https://www.mongodb.com/docs/atlas/app-services/sync/error-handling/client-resets/) is required.
    - `is_recovery_mode_disabled` boolean — Specifies whether the [client reset mode](https://www.mongodb.com/docs/atlas/app-services/sync/error-handling/client-resets/#recover-unsynced-changes) is disabled. By default, client reset mode is enabled and this value is `false`.
    - `asymmetric_tables` string[] — An array of the names of collections that are defined as asymmetric with [Data Ingest](https://www.mongodb.com/docs/atlas/app-services/sync/configure/sync-settings/#data-ingest), where clients can write data but not read.
  - `groupName` string — The name of the App's Atlas Project.
  - `orgName` string — The name of the App's Atlas Organization.
  - `readPreference` 'primary' | 'primaryPreferred' | 'secondary' | 'secondaryPreferred' | 'nearest'
  - `wireProtocolEnabled` boolean — If true, clients may [connect to the app over the MongoDB Wire Protocol](https://www.mongodb.com/docs/atlas/app-services/mongodb/wire-protocol/#connect-over-the-wire-protocol).

---

[API](https://skmtc.net/mongodb/apis/mongodb-atlas-app-services-admin-api.md) · [All operations](https://skmtc.net/mongodb/apis/mongodb-atlas-app-services-admin-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/mongodb/mongodb-atlas-app-services-admin-api/revisions/1365ab72bc03/schema)