Skip to main content
GET
/
v1
/
jobs
/
{job_id}
Get Job
curl --request GET \
  --url https://sdk.nimbleway.com/v1/jobs/{job_id} \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://sdk.nimbleway.com/v1/jobs/{job_id}"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://sdk.nimbleway.com/v1/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://sdk.nimbleway.com/v1/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 => [
"Authorization: Bearer <token>"
],
]);

$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://sdk.nimbleway.com/v1/jobs/{job_id}"

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

req.Header.Add("Authorization", "Bearer <token>")

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

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

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://sdk.nimbleway.com/v1/jobs/{job_id}")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://sdk.nimbleway.com/v1/jobs/{job_id}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "id": "<string>",
  "name": "<string>",
  "display_name": "<string>",
  "agent_name": "<string>",
  "description": "<string>",
  "schedule": {
    "cron": "<string>",
    "enabled": true
  },
  "inputs": {
    "file_path": "<string>",
    "data": [
      {}
    ]
  },
  "destination": {
    "path": "<string>",
    "format": "parquet"
  },
  "last_run_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

job_id
string
required

Cookies

token
string | null

Response

Successful Response

A configured job: an agent plus its schedule, inputs, and destination.

id
string
required

Unique job identifier (job_).

Pattern: ^job_[1-9][0-9]*$
name
string
required

Job name.

display_name
string | null

Human-friendly job name shown in the UI.

agent_name
string | null

Name of the agent this job runs.

description
string | null

Free-text description of the job.

schedule
JobSchedule · object | null

Cron schedule controlling automatic runs.

inputs
JobInputs · object | null

Input data configuration for the job.

destination
JobDestination · object | null

Where the job writes its results.

last_run_at
string<date-time> | null

Timestamp of the most recent run.

last_run_status
enum<string> | null

Status of the most recent run.

Available options:
PENDING,
RUNNING,
SUCCESS,
FAILED,
CANCELLED,
TIMEOUT,
WARNING
created_at
string<date-time> | null

When the job was created.

updated_at
string<date-time> | null

When the job was last updated.