List Jobs

Returns a list of jobs associated with the authenticated account.

GET /jobs

List Jobs

cURL

curl --request GET \
  --url https://api.xplenty.com/{account_id}/api/jobs \
  --header 'Accept: <accept>' \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://api.xplenty.com/{account_id}/api/jobs"

headers = {
    "Accept": "<accept>",
    "Authorization": "Basic <encoded-value>"
}

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

print(response.text)

const options = {
  method: 'GET',
  headers: {Accept: '<accept>', Authorization: 'Basic <encoded-value>'}
};

fetch('https://api.xplenty.com/{account_id}/api/jobs', 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.xplenty.com/{account_id}/api/jobs",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Accept: <accept>",
    "Authorization: Basic <encoded-value>"
  ],
]);

$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.xplenty.com/{account_id}/api/jobs"

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

	req.Header.Add("Accept", "<accept>")
	req.Header.Add("Authorization", "Basic <encoded-value>")

	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.xplenty.com/{account_id}/api/jobs")
  .header("Accept", "<accept>")
  .header("Authorization", "Basic <encoded-value>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.xplenty.com/{account_id}/api/jobs")

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

request = Net::HTTP::Get.new(url)
request["Accept"] = '<accept>'
request["Authorization"] = 'Basic <encoded-value>'

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

200

[
  {
    "id": 157,
    "status": "completed",
    "owner_id": 123,
    "progress": 1,
    "outputs_count": 2,
    "outputs": [
      {
        "id": 123,
        "name": "projected_results",
        "records_count": 10415234,
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "url": "<string>",
        "component": {
          "name": "<string>",
          "type": "<string>",
          "fields": [
            "<string>"
          ]
        }
      }
    ],
    "variables": {},
    "dynamic_variables": {},
    "started_at": "2023-11-07T05:31:56Z",
    "created_at": "2023-11-07T05:31:56Z",
    "failed_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "cluster_id": 52,
    "package_id": 434,
    "errors": "<string>",
    "runtime_in_seconds": 123,
    "url": "<string>",
    "html_url": "<string>",
    "log_url": "<string>",
    "creator": {
      "type": "<string>",
      "display_name": "<string>",
      "id": 123,
      "url": "<string>"
    },
    "package": {
      "id": 123,
      "name": "<string>",
      "url": "<string>"
    },
    "cluster": {
      "id": 123,
      "name": "<string>",
      "url": "<string>"
    }
  }
]

{
  "message": "Item not found."
}

Authorizations

Authorization · string · header · required

Enter your API key as the username. Leave the password field blank. Example: curl -u YOUR_API_KEY: https://api.xplenty.com/...

Headers

Accept · string · default: application/vnd.xplenty+json; version=2 · required

API version header — required on all requests

Query Parameters

offset · integer · default: 0

Index of the first object to retrieve (starting from 0)

Required range: x >= 0

limit · integer · default: 20

Number of items to return (max 100)

Required range: 1 <= x <= 100

status · enum<string>

Filter by job status

Available options: idle, pending, queued, running, completed, failed, pending_stoppage, stopping, stopped

sort · enum<string>

Sort field

Available options: id, status, created_at, updated_at

direction · enum<string> · default: desc

Sort direction

Available options: asc, desc

since · string<date-time>

Only return jobs updated at the given time or later (ISO 8601)

Response

200

application/vnd.xplenty+json; version=2

Successful response

id · integer

Example:

157

status · enum<string>

Available options: idle, pending, queued, running, completed, failed, pending_stoppage, stopping, stopped

Example:

"completed"

owner_id · integer

progress · number<double>

Required range: 0 <= x <= 1

Example:

1

outputs_count · integer

Example:

2

outputs · object[]

Show child attributes

variables · object

dynamic_variables · object

started_at · string<date-time> | null

created_at · string<date-time>

failed_at · string<date-time> | null

updated_at · string<date-time>

cluster_id · integer

Example:

52

package_id · integer

Example:

434

errors · string

runtime_in_seconds · integer

url · string<uri>

html_url · string<uri>

log_url · string<uri> | null

creator · object

Show child attributes

package · object

Show child attributes

cluster · object

Show child attributes