General
Server Side SDKs
Core API
- Companies
- Invite Links
- Sync
- Passthrough
- Real Time
- Webhooks
Unified API
- Accounting
- Payments
- Ecommerce
- CRM
Sync
Get Sync Config
Retrieve the sync config for your organization.
GET
/
core
/
syncs
/
config
curl --request GET \
--url https://api.rootfi.dev/v3/core/syncs/config \
--header 'api_key: <api-key>'{
"sync_config": [
{
"enabled": true,
"interval": 1,
"frequency": "DAILY",
"data_model": "ACCOUNTS",
"category": "ACCOUNTING",
"scope_access": {
"READ": true,
"CREATE": true,
"UPDATE": true,
"DELETE": true
},
"sync_from": "2023-11-07T05:31:56Z",
"custom_fields": [
"<string>"
]
}
]
}Authorizations
Query Parameters
The integration category whose sync config you want to retrieve
Available options:
ACCOUNTING, PAYMENTS, CRM, ECOMMERCE, CUSTOM Response
200
application/json
The data of the sync config endpoint
The sync configuration data for your organization
The status of the sync configuration
Example:
true
The interval of the sync configuration
Example:
1
The frequency of the sync configuration
Available options:
DAILY, WEEKLY, MONTHLY, YEARLY The data model of the sync configuration
Available options:
ACCOUNTS, BANK_ACCOUNTS, BILLS, BILL_PAYMENTS, COMPANY_INFO, CONTACTS, BILL_CREDIT_NOTES, INVOICE_CREDIT_NOTES, DOCUMENTS, EXPENSES, INVOICES, INVOICE_PAYMENTS, ITEMS, LINE_ITEMS, TAX_RATES, JOURNAL_ENTRIES, BANK_TRANSACTIONS, JOURNAL_LINES, PURCHASE_ORDERS, SALES_ORDERS, PHONE_NUMBERS, ADDRESSES, EXTERNAL_LINKS, CONTACT_PERSONS, INCOME_STATEMENT, BALANCE_SHEET, TRACKING_CATEGORIES, CASH_FLOW_STATEMENT, CURRENCIES, PAYMENT_CUSTOMERS, PAYMENT_INVOICES, PAYMENT_LINE_ITEMS, PAYMENT_ITEMS, PAYMENT_ORDERS, PAYMENT_TAX_RATES, PAYMENT_DISPUTES, PAYMENT_PAYMENTS, PAYMENT_REFUNDS, PAYMENT_PAYMENT_LINKS, PAYMENT_PAYOUTS, PAYMENT_ADDRESSES, PAYMENT_PHONE_NUMBERS, PAYMENT_EXTERNAL_LINKS, PAYMENT_TRANSACTIONS, PAYMENT_BALANCES, ECOMMERCE_ORDERS, ECOMMERCE_CUSTOMERS, ECOMMERCE_PRODUCTS, ECOMMERCE_LINE_ITEMS, CRM_CONTACTS, CRM_COMPANIES, CRM_DEALS, CRM_LEADS, CRM_NOTES, CRM_PIPELINES, CRM_STAGES, CRM_ACTIVITIES, CRM_TASKS, CRM_USERS, CRM_EXTERNAL_LINKS, CRM_PHONE_NUMBERS, CRM_ADDRESSES The category of the datamodel
Available options:
ACCOUNTING, PAYMENTS, CRM, ECOMMERCE, CUSTOM The scope access of the sync configuration
The date from which the data should be synced. If not provided, it will sync all historical data.
The custom field names to fetch during syncing (for Netsuite, Hubspot only)
curl --request GET \
--url https://api.rootfi.dev/v3/core/syncs/config \
--header 'api_key: <api-key>'{
"sync_config": [
{
"enabled": true,
"interval": 1,
"frequency": "DAILY",
"data_model": "ACCOUNTS",
"category": "ACCOUNTING",
"scope_access": {
"READ": true,
"CREATE": true,
"UPDATE": true,
"DELETE": true
},
"sync_from": "2023-11-07T05:31:56Z",
"custom_fields": [
"<string>"
]
}
]
}