Skip to main content
GET
/
core
/
organizations
/
sync-config
Get Sync Config
curl --request GET \
  --url https://api.integrations.commenda.io/v4/core/organizations/sync-config \
  --header 'api_key: <api-key>'
{
  "data": {
    "syncConfig": [
      {
        "dataModel": "ACCOUNT",
        "category": "ACCOUNTING",
        "enabled": true,
        "scopeAccess": {
          "READ": true,
          "CREATE": false,
          "DELETE": false,
          "UPDATE": false
        },
        "frequency": "WEEKLY",
        "interval": 2,
        "syncFrom": null,
        "isOverridden": false,
        "isChild": false
      }
    ]
  },
  "request_id": "09800ee2-c236-4438-81b9-da85b71a83df"
}

Documentation Index

Fetch the complete documentation index at: https://integrations.docs.commenda.io/llms.txt

Use this file to discover all available pages before exploring further.

Get organization sync config for an integration type.

​
Query Parameters

ParameterTypeRequiredDescription
integration_typeenumYesIntegration type (e.g. NETSUITE).

​
Response

Returns { data: { syncConfig }, request_id }. Each syncConfig[] entry includes dataModel, category, enabled, scopeAccess, frequency, interval, syncFrom, isOverridden, and isChild. See company sync config.

Authorizations

​
api_key
string
header
required

Query Parameters

​
integration_type
enum<string>
required

Integration type. V4-supported integration types only.

Available options:
STRIPE,
NETSUITE,
XERO,
ZOHO_BOOKS,
WAFEQ,
QUICKBOOKS,
QUICKBOOKS_SANDBOX,
BIG_COMMERCE,
WOO_COMMERCE,
OODOO_ACCOUNTING,
SHOPIFY,
FRESHBOOKS

Response

Sync config for the integration type.

​
request_id
string
required
​
data
V4GetOrgSyncConfigResponse · object
required