---
title: "Get Partition-Based Sync information"
method: GET
path: "/groups/{groupId}/apps/{appId}/sync/data"
tags: ["sync"]
---

# Get Partition-Based Sync information

`GET /groups/{groupId}/apps/{appId}/sync/data`

Retrieve partition field data when using 
[Partition-Based Sync](https://www.mongodb.com/docs/atlas/app-services/reference/partition-based-sync).

## Query parameters

- `service_id` string, required

## Response `200`

Successfully retrieved.

- PbsSyncResponse
  - `service_id` string — The Service ID for the currently synced cluster, if there is one.
  - `partition_fields` Partition[] — A list of valid partition keys based on the cluster's collection schemas.
    - `key` string
    - `type` string

## Changes

- **2023-09-18** (v3) `5a6e55caba1e` — 8 warning, 3 info
  - removed the optional property `clusterId` from the response with the `200` status
  - removed the optional property `clusterName` from the response with the `200` status
  - removed the optional property `clusterType` from the response with the `200` status
  - removed the optional property `flexible_sync` from the response with the `200` status
  - …7 more
- **2023-09-13** (v3) `949b0627dd2a` — 2 warning, 9 info
  - removed the optional property `partition_fields` from the response with the `200` status
  - removed the optional property `service_id` from the response with the `200` status
  - api operation id `adminGetSync` removed and replaced with `adminGetPartitionSync`
  - added the optional property `clusterId` to the response with the `200` status
  - …7 more

[Change history](https://skmtc.dev/mongodb/apis/mongodb-atlas-app-services-admin-api/changes/groups/:groupId/apps/:appId/sync/data/get.md)

---

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