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


{
  "data": {
    "data": [
      {
        "rootfi_id": 123456,
        "rootfi_company_id": 123456,
        "rootfi_organisation_id": 1,
        "rootfi_integration_type": "ZOHO_BOOKS",
        "rootfi_updated_at": "2021-09-28T15:00:00.000Z",
        "rootfi_created_at": "2021-09-28T15:00:00.000Z",
        "start_time": "2021-09-28T15:00:00.000Z",
        "end_time": "2021-09-28T15:00:00.000Z",
        "sync_from": null,
        "integration_type": "ZOHO_BOOKS",
        "full_sync": true,
        "sync_type": "AUTO_SYNC",
        "config_mode": "READ",
        "success_count": 20,
        "failed_count": 0,
        "running_count": 0,
        "created_count": 0,
        "data_models": [
          {
            "sync_id": "H1HJT1UYdj0qncJ",
            "data_model": "ACCOUNTS",
            "total_count": 1,
            "success_count": 1,
            "failed_count": 0,
            "running_count": 0,
            "pending_count": 0,
            "start_time": "2023-12-01T08:17:29+00:00",
            "end_time": "2023-12-01T08:17:43.047+00:00",
            "status": "SUCCESS"
          }
        ]
      }
    ],
    "total_count": 1,
    "sync_status": "IDLE",
    "connection_status": "HEALTHY"
  },
  "request_timestamp": "2021-09-28T15:00:00.000Z",
  "response_timestamp": "2021-09-28T15:00:00.000Z",
  "request_id": "7a1c0e42-9f85-4d6e-bb5d-358a72913c0b"
}
curl --request GET \
  --url https://api.rootfi.dev/sync \
  --header 'api_key: <api-key>'

Authorizations

​
api_key
string
header
required

Query Parameters

​
limit
integer | null

The number of objects you want to retrieve

​
offset
integer | null

The index from where you want to start retrieving objects

​
company_id
integer | null

The ID of the company to retrieve.

​
job_type
enum<string>

The type of job to retrieve.

Available options:
PULL,
PUSH

Response

200 - application/json
​
data
object
required

The data returned from the request

​
request_timestamp
string<date-time>
required

The time at which the request was received by the server

​
response_timestamp
string<date-time>
required

The time at which the response was sent by the server

​
request_id
string
required

The unique ID of the request