Get Syncs

GET

core

syncs

curl --request GET \
  --url https://api.rootfi.dev/v3/core/syncs \
  --header 'api_key: <api-key>'

{
  "data": [
    {
      "rootfi_id": 1,
      "rootfi_created_at": "2021-08-31T18:00:00Z",
      "rootfi_updated_at": "2021-08-31T18:00:00Z",
      "rootfi_company_id": 1,
      "start_time": "2021-08-31T18:00:00Z",
      "end_time": "2021-08-31T18:00:00Z",
      "integration_type": "XERO",
      "full_sync": true,
      "sync_type": "AUTO_SYNC",
      "config_mode": "READ",
      "sync_data_models": [
        "ACCOUNTS",
        "CONTACTS"
      ],
      "sync_id": "VmaVgKMaiygMzTK1",
      "total_count": 100,
      "success_count": 100,
      "failed_count": 0,
      "running_count": 0,
      "pending_count": 0,
      "status": "SUCCESS"
    }
  ],
  "next": "https://api.rootfi.dev/syncs?next=eyJpZCI6MX0%3D"
}

Authorizations

api_key

string

header

required

Query Parameters

limit

integer | null

The number of objects you want to retrieve

rootfi_company_id

integer | null

The ID of the company

string | null

The next page of objects to retrieve

string | null

The previous page of objects to retrieve

Response

200

application/json

The data of the syncs endpoint

data

object[]

required

The data of the invite link endpoint

data.rootfi_id

integer

required

The ID of the sync

Example:

1

data.rootfi_created_at

string

required

The created time of the sync

Example:

"2024-06-21T08:07:05.750Z"

data.rootfi_updated_at

string

required

The updated time of the sync

Example:

"2024-06-21T08:07:05.750Z"

data.rootfi_company_id

integer

required

The ID of the company

Example:

8422

data.start_time

string

required

The start time of the sync

Example:

"2024-06-21T08:07:05.000Z"

data.end_time

string

required

The end time of the sync

Example:

"2024-06-21T08:07:40.382Z"

data.integration_type

enum<string>

required

The type of integration

Available options:

ZOHO_BOOKS,

QUICKBOOKS_SANDBOX,

QUICKBOOKS,

XERO,

TALLY,

ROOTFI_SANDBOX,

SAGE_CLOUD_ACCOUNTING,

MS_DYNAMICS_365,

SAGE_ZA_CLOUD_ACCOUNTING,

MYOB_BUSINESS,

NETSUITE,

WAVE,

ODOO_ACCOUNTING,

WAFEQ,

MEKARI_JURNAL,

BUSY,

QOYOD,

STRIPE,

RAZORPAY,

PAYPAL,

SHOPIFY,

BIG_COMMERCE,

WOO_COMMERCE,

HUBSPOT,

SALESFORCE,

PIPEDRIVE,

ZOHO_CRM

data.full_sync

boolean

required

Whether the sync was a full sync

Example:

true

data.sync_type

enum<string>

required

The type of sync.

Available options:

MANUAL,

AUTO_SYNC

data.config_mode

enum<string>

required

The config mode of the sync.

Available options:

CREATE,

READ,

UPDATE,

DELETE,

DOWNLOAD,

CUSTOM

data.sync_data_models

string[]

required

The sync data models of the sync.

Example:

["CUSTOM_ACCOUNT_TRANSACTIONS"]

data.sync_id

string

required

The ID of the sync

Example:

"hjmm4d2HDHB60a2"

data.total_count

integer

required

The total count of the sync

Example:

3

data.success_count

integer

required

The success count of the sync

Example:

3

data.failed_count

integer

required

The failed count of the sync

Example:

0

data.running_count

integer

required

The running count of the sync

Example:

0

data.pending_count

integer

required

The pending count of the sync

Example:

0

data.status

enum<string>

required

The status of the sync

Available options:

CREATED,

RUNNING,

SUCCESS,

FAILED

string | null

The next page of objects to retrieve

Create Sync Get Sync

curl --request GET \
  --url https://api.rootfi.dev/v3/core/syncs \
  --header 'api_key: <api-key>'

{
  "data": [
    {
      "rootfi_id": 1,
      "rootfi_created_at": "2021-08-31T18:00:00Z",
      "rootfi_updated_at": "2021-08-31T18:00:00Z",
      "rootfi_company_id": 1,
      "start_time": "2021-08-31T18:00:00Z",
      "end_time": "2021-08-31T18:00:00Z",
      "integration_type": "XERO",
      "full_sync": true,
      "sync_type": "AUTO_SYNC",
      "config_mode": "READ",
      "sync_data_models": [
        "ACCOUNTS",
        "CONTACTS"
      ],
      "sync_id": "VmaVgKMaiygMzTK1",
      "total_count": 100,
      "success_count": 100,
      "failed_count": 0,
      "running_count": 0,
      "pending_count": 0,
      "status": "SUCCESS"
    }
  ],
  "next": "https://api.rootfi.dev/syncs?next=eyJpZCI6MX0%3D"
}

General

Server Side SDKs

Core API

Unified API

Authorizations

Query Parameters

Response