Get Job

Retrieve a single sync job from the database.

GET /core/syncs/jobs/{job_id}

Get Job

cURL

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

import requests

url = "https://api.rootfi.dev/v3/core/syncs/jobs/{job_id}"

headers = {"api_key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {api_key: '<api-key>'}};

fetch('https://api.rootfi.dev/v3/core/syncs/jobs/{job_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.rootfi.dev/v3/core/syncs/jobs/{job_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "api_key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.rootfi.dev/v3/core/syncs/jobs/{job_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("api_key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.rootfi.dev/v3/core/syncs/jobs/{job_id}")
  .header("api_key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.rootfi.dev/v3/core/syncs/jobs/{job_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["api_key"] = '<api-key>'

response = http.request(request)
puts response.read_body

200

{
  "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
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "field": "<string>"
  }
}

Authorizations

api_key · string · header · required

Path Parameters

job_id · string · required

The ID of the job to retrieve

Response

200

application/json

The data of the job endpoint

data · coreJobData · object · required

The data of the job endpoint

Show child attributes