Get a job - Extole Documentation

Get a job

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

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

fetch('https://api.extole.io/v6/jobs/{jobId}', 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/{jobId}",
  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/{jobId}"

	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/{jobId}")

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>",
  "created_date": "2025-10-24T02:00:00-07:00",
  "enabled": true,
  "id": "<string>",
  "name": "<string>",
  "tasks": [
    {
      "id": "<string>",
      "order": 123,
      "task_type": "FILE_HEADER_VALIDATOR",
      "expected_headers": [
        "<string>"
      ]
    }
  ],
  "triggers": [
    {
      "id": "<string>",
      "trigger_type": "FILE_NAME_MATCHES",
      "pattern": "<string>"
    }
  ],
  "updated_date": "2025-10-24T02:00:00-07:00"
}

GET

/

v6

/

jobs

/

{jobId}

Get a job

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

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

fetch('https://api.extole.io/v6/jobs/{jobId}', 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/{jobId}",
  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/{jobId}"

	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/{jobId}")

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>",
  "created_date": "2025-10-24T02:00:00-07:00",
  "enabled": true,
  "id": "<string>",
  "name": "<string>",
  "tasks": [
    {
      "id": "<string>",
      "order": 123,
      "task_type": "FILE_HEADER_VALIDATOR",
      "expected_headers": [
        "<string>"
      ]
    }
  ],
  "triggers": [
    {
      "id": "<string>",
      "trigger_type": "FILE_NAME_MATCHES",
      "pattern": "<string>"
    }
  ],
  "updated_date": "2025-10-24T02:00:00-07:00"
}

Authorizations

Authorization

string

header

required

Path Parameters

jobId

string

required

Response

Successful response

client_id

string

required

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

boolean

required

id

string

required

read-only

name

string

required

tasks

(FILE_HEADER_VALIDATOR · object | START_BATCH_JOB · object)[]

required

FILE_HEADER_VALIDATOR
START_BATCH_JOB

Show child attributes

triggers

(FILE_NAME_MATCHES · object | LANDS_IN_DIRECTORY · object)[]

required

FILE_NAME_MATCHES
LANDS_IN_DIRECTORY

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"

Create a job Update a job