---
title: "Get sync settings"
method: GET
path: "/profile/syncSettings"
tags: ["Settings"]
---

# Get sync settings

`GET /profile/syncSettings`

Retrieve the [sync settings](https://docs.codat.io/knowledge-base/advanced-sync-settings) for your client. This includes how often data types should be queued to be updated, and how much history should be fetched.

## Response `200`

OK

- SyncSettings
  - `clientId` string, uuid — Unique identifier for your client in Codat.
  - `settings` SyncSetting[]
    - `dataType` DataType, required — unresolved $ref
    - `fetchOnFirstLink` boolean, required — Whether this data type should be queued after a company has authorized a connection.
    - `syncSchedule` integer, required — Number of hours after which this data type should be refreshed.
    - `syncOrder` integer, required — The sync in which data types are queued for a sync.
    - `syncFromUtc` string — In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. Date and time fields are formatted as strings; for example: ``` 2020-10-08T22:40:50Z 2021-01-01T00:00:00 ``` When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information: - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z` - Unqualified local time: `2021-11-15T01:00:00` - UTC time offsets: `2021-11-15T01:00:00-05:00` > Time zones > > Not all dates from Codat will contain information about time zones. > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced.
    - `syncFromWindow` integer — Number of months of data to be fetched. Set this *or* `syncFromUTC`.
    - `monthsToSync` integer — Months of data to fetch, for report data types (`balanceSheet` & `profitAndLoss`) only.
    - `isLocked` boolean — `True` if the [sync setting](https://docs.codat.io/knowledge-base/advanced-sync-settings) is locked.
  - `overridesDefaults` boolean — Set to `True` if you want to override the default [sync settings](https://docs.codat.io/knowledge-base/advanced-sync-settings).

## Other responses

- `401` — Your API request was not properly authorized.
- `402` — An account limit has been exceeded. The type of limit is described in the error property: - You have exceeded the 50-company limit that applies to a Free plan. Delete any companies you no longer need and retry the request. - The requested sync schedule is not allowed. You requested an hourly sync schedule but this functionality is not included in the Free plan. - Your Free account is older than 365 days and has expired. Contact support@codat.io.
- `403` — You are using an outdated API key or a key not associated with that resource.
- `429` — Too many requests were made in a given amount of time. Wait a short period and then try again.
- `500` — There is a problem with our server. Please try again later.
- `503` — The Codat API is temporarily offline for maintenance. Please try again later.

---

[API](https://skmtc.dev/codatio/apis/platform-api.md) · [All operations](https://skmtc.dev/codatio/apis/platform-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/codatio/platform-api/revisions/bff9b9776ecf/schema)