Sign in

v52

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-045244247.9 KB
Settings

Get sync settings

Retrieve the sync settings for your client. This includes how often data types should be queued to be updated, and how much history should be fetched.

get/profile/syncSettings

Response

OK

clientIdstring uuid

Unique identifier for your client in Codat.

overridesDefaultsboolean

Set to True if you want to override the default sync settings.

Example response

{
  "settings": [
    {
      "dataType": "invoices",
      "fetchOnFirstLink": true,
      "syncSchedule": 24,
      "syncOrder": 0,
      "syncFromUtc": "2020-01-01T12:00:00.000Z",
      "syncFromWindow": 24,
      "monthsToSync": 24,
      "isLocked": true
    }
  ]
}