GET
/
sync
/
{sync_id}
curl --request GET \
  --url https://api.rootfi.dev/sync/{sync_id} \
  --header 'api_key: <api-key>'
{
  "data": {
    "config_mode": "READ",
    "end_time": "2021-09-28T15:00:00.000Z",
    "full_sync": true,
    "integration_type": "ZOHO_BOOKS",
    "jobs": [
      {
        "data_model": "PURCHASE_ORDERS",
        "end_time": "2023-12-01T08:17:55.36+00:00",
        "error_code": null,
        "response_length": 0,
        "response_size": 0,
        "rootfi_created_at": "2023-12-01T08:17:53+00:00",
        "rootfi_id": "9c3GuWp0KVomqrS",
        "start_time": "2023-12-01T08:17:53+00:00",
        "status": "SUCCESS"
      }
    ],
    "rootfi_company_id": 123456,
    "rootfi_created_at": "2021-09-28T15:00:00.000Z",
    "rootfi_id": 123456,
    "rootfi_integration_type": "ZOHO_BOOKS",
    "rootfi_organisation_id": 1,
    "rootfi_updated_at": "2021-09-28T15:00:00.000Z",
    "start_time": "2021-09-28T15:00:00.000Z",
    "sync_type": "AUTO_SYNC"
  },
  "request_id": "7a1c0e42-9f85-4d6e-bb5d-358a72913c0b",
  "request_timestamp": "2021-09-28T15:00:00.000Z",
  "response_timestamp": "2021-09-28T15:00:00.000Z"
}

Authorizations

api_key
string
headerrequired

Path Parameters

sync_id
string
required

The ID of the Sync to retrieve.

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

job_type
enum<string>

The type of job to retrieve.

Available options:
PULL,
PUSH

Response

200 - application/json
data
object
required
request_id
string
required

The unique ID of the request

request_timestamp
string
required

The time at which the request was received by the server

response_timestamp
string
required

The time at which the response was sent by the server