List jobs

List jobs

curl --request GET \
  --url https://api.extole.io/v6/jobs \
  --header 'Authorization: <api-key>'

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

fetch('https://api.extole.io/v6/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.extole.io/v6/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 => [
    "Authorization: <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.extole.io/v6/jobs"

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

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

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.extole.io/v6/jobs")

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

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

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

[
  {
    "client_id": "<string>",
    "component_ids": [
      "<string>"
    ],
    "component_references": [
      {
        "component_id": "<string>",
        "socket_names": [
          "<string>"
        ]
      }
    ],
    "created_date": "2025-10-24T02:00:00-07:00",
    "enabled": true,
    "id": "<string>",
    "name": "<string>",
    "tasks": [
      {
        "component_ids": [
          "<string>"
        ],
        "component_references": [
          {
            "component_id": "<string>",
            "socket_names": [
              "<string>"
            ]
          }
        ],
        "id": "<string>",
        "order": 123,
        "parent_job_id": "<string>",
        "task_type": "FILE_HEADER_VALIDATOR",
        "expected_headers": [
          "<string>"
        ],
        "match_mode": "EXACT_SET",
        "on_mismatch": "FAIL"
      }
    ],
    "triggers": [
      {
        "component_ids": [
          "<string>"
        ],
        "component_references": [
          {
            "component_id": "<string>",
            "socket_names": [
              "<string>"
            ]
          }
        ],
        "id": "<string>",
        "parent_job_id": "<string>",
        "trigger_type": "FILE_NAME_MATCHES",
        "match_type": "EXACT",
        "pattern": "<string>"
      }
    ],
    "updated_date": "2025-10-24T02:00:00-07:00"
  }
]

GET

jobs

List jobs

curl --request GET \
  --url https://api.extole.io/v6/jobs \
  --header 'Authorization: <api-key>'

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

fetch('https://api.extole.io/v6/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.extole.io/v6/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 => [
    "Authorization: <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.extole.io/v6/jobs"

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

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

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.extole.io/v6/jobs")

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

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

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

[
  {
    "client_id": "<string>",
    "component_ids": [
      "<string>"
    ],
    "component_references": [
      {
        "component_id": "<string>",
        "socket_names": [
          "<string>"
        ]
      }
    ],
    "created_date": "2025-10-24T02:00:00-07:00",
    "enabled": true,
    "id": "<string>",
    "name": "<string>",
    "tasks": [
      {
        "component_ids": [
          "<string>"
        ],
        "component_references": [
          {
            "component_id": "<string>",
            "socket_names": [
              "<string>"
            ]
          }
        ],
        "id": "<string>",
        "order": 123,
        "parent_job_id": "<string>",
        "task_type": "FILE_HEADER_VALIDATOR",
        "expected_headers": [
          "<string>"
        ],
        "match_mode": "EXACT_SET",
        "on_mismatch": "FAIL"
      }
    ],
    "triggers": [
      {
        "component_ids": [
          "<string>"
        ],
        "component_references": [
          {
            "component_id": "<string>",
            "socket_names": [
              "<string>"
            ]
          }
        ],
        "id": "<string>",
        "parent_job_id": "<string>",
        "trigger_type": "FILE_NAME_MATCHES",
        "match_type": "EXACT",
        "pattern": "<string>"
      }
    ],
    "updated_date": "2025-10-24T02:00:00-07:00"
  }
]

Authorizations

Authorization

string

header

required

Response

Successful response

client_id

string

required

component_ids

string[]

required

component_references

object[]

required

Show child attributes

created_date

string

required

RFC 3339 or RFC 9557 date-time with a numeric UTC offset and an optional IANA time-zone suffix in square brackets. Precision up to milliseconds.

Pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,3})?(Z|[+-](?:[01][0-9]|2[0-3]):[0-5][0-9])(\[[^\]]+\])?$

Example:

"2025-10-24T02:00:00-07:00"

enabled

required

Whether the job runs when triggered. A literal value or a buildtime expression resolved from component references when the job is saved. Buildtime expressions use JobBuildtimeContext.

string

required

read-only

name

string

required

tasks

object[]

required

Stored task definition. Field order is unevaluated and appears in buildtime-evaluatable form.

Option 1
Option 2
Option 3

Show child attributes

triggers

object[]

required

Stored file name matches trigger definition. Fields match_type and pattern are unevaluated and appear in buildtime-evaluatable form.

Option 1
Option 2

Show child attributes

updated_date

string

required

RFC 3339 or RFC 9557 date-time with a numeric UTC offset and an optional IANA time-zone suffix in square brackets. Precision up to milliseconds.

Pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,3})?(Z|[+-](?:[01][0-9]|2[0-3]):[0-5][0-9])(\[[^\]]+\])?$

Example:

"2025-10-24T02:00:00-07:00"

⌘I

Getting Started

Consumer to Extole API

Server to Extole API

Management API

Authorizations

Response