Get Sync Jobs

GET

core

syncs

{sync_id}

jobs

curl --request GET \
  --url https://api.rootfi.dev/v3/core/syncs/{sync_id}/jobs \
  --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",
      "status": "SUCCESS",
      "data_model": "ACCOUNTS",
      "config_mode": "READ",
      "sync_id": "VmaVgKMaiygMzTK1",
      "parent_job_id": "VmaVgKMaiygMzTK1",
      "retry_count": 0,
      "priority": 0,
      "variables": {},
      "error": {},
      "config_id": "VmaVgKMaiygMzTK1",
      "job_type": "PUSH",
      "response_length": 0,
      "response_size": 0,
      "rate_limit_sleep_time": 0
    }
  ],
  "next": "eyJpZCI6MX0%3DMX0%3DMX0%3DMX0%3DMX0%3D"
}

Authorizations

api_key

string

header

required

Path Parameters

sync_id

string

required

The ID of the sync to retrieve

Response

200

application/json

The data of the sync jobs endpoint

data

object[]

required

The data of the sync jobs endpoint

The data of the job endpoint

data.rootfi_id

integer

required

The unique ID we assign for that data's information

data.rootfi_created_at

string

required

The date at which RootFi first synced this data

data.rootfi_updated_at

string

required

The latest date at which RootFi updated this data

data.rootfi_company_id

integer

required

The ID of the company

data.start_time

string

required

The start time of the job

data.end_time

string

required

The end time of the job

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.status

enum<string>

required

The status of the job

Available options:

CREATED,

RUNNING,

SUCCESS,

FAILED

data.data_model

enum<string>

required

The data model of the job

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

data.config_mode

enum<string>

required

The config mode of the job

Available options:

CREATE,

READ,

UPDATE,

DELETE,

DOWNLOAD,

CUSTOM

data.sync_id

string

required

The ID of the sync

data.retry_count

integer

required

The retry count of the job

data.config_id

string

required

The config ID of the job

data.job_type

enum<string>

required

The job type of the job

Available options:

PUSH,

PULL

data.parent_job_id

string | null

The ID of the parent job

data.priority

integer | null

The priority of the job

data.variables

object | null

The variables of the job

data.error

object | null

The error of the job

data.response_length

integer | null

The response length of the job

data.response_size

integer | null

The response size of the job

data.rate_limit_sleep_time

integer | null

The rate limit sleep time of the job

string | null

The next page of objects to retrieve

Get Sync Get Job

curl --request GET \
  --url https://api.rootfi.dev/v3/core/syncs/{sync_id}/jobs \
  --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",
      "status": "SUCCESS",
      "data_model": "ACCOUNTS",
      "config_mode": "READ",
      "sync_id": "VmaVgKMaiygMzTK1",
      "parent_job_id": "VmaVgKMaiygMzTK1",
      "retry_count": 0,
      "priority": 0,
      "variables": {},
      "error": {},
      "config_id": "VmaVgKMaiygMzTK1",
      "job_type": "PUSH",
      "response_length": 0,
      "response_size": 0,
      "rate_limit_sleep_time": 0
    }
  ],
  "next": "eyJpZCI6MX0%3DMX0%3DMX0%3DMX0%3DMX0%3D"
}

General

Server Side SDKs

Core API

Unified API

Authorizations

Path Parameters

Response