List all batch jobs
curl --request GET \
--url https://api.revenuebase.ai/v2/jobs/all \
--header 'x-key: <api-key>'import requests
url = "https://api.revenuebase.ai/v2/jobs/all"
headers = {"x-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-key': '<api-key>'}};
fetch('https://api.revenuebase.ai/v2/jobs/all', 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.revenuebase.ai/v2/jobs/all",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-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.revenuebase.ai/v2/jobs/all"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-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.revenuebase.ai/v2/jobs/all")
.header("x-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.revenuebase.ai/v2/jobs/all")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"processes": [],
"page": 1,
"batch": 10,
"total": 0
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Utilities
List all batch jobs
Find batch jobs across active, completed, cancelled, and failed states.
GET
/
v2
/
jobs
/
all
List all batch jobs
curl --request GET \
--url https://api.revenuebase.ai/v2/jobs/all \
--header 'x-key: <api-key>'import requests
url = "https://api.revenuebase.ai/v2/jobs/all"
headers = {"x-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-key': '<api-key>'}};
fetch('https://api.revenuebase.ai/v2/jobs/all', 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.revenuebase.ai/v2/jobs/all",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-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.revenuebase.ai/v2/jobs/all"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-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.revenuebase.ai/v2/jobs/all")
.header("x-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.revenuebase.ai/v2/jobs/all")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"processes": [],
"page": 1,
"batch": 10,
"total": 0
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Credits and plans
PAYG is Pay-as-you-go. AYCE is All-you-can-eat.| Usage | PAYG | AYCE |
|---|---|---|
| This request | Free 0 credits | Free 0 credits |
exportId and their own export status endpoints.
When to use this endpoint
Find a completed job for downloading, recover a lost process_id, or inspect a failed run. You can filter by one status.Example
SetREVENUEBASE_API_KEY to your API key.
curl --request GET 'https://api.revenuebase.ai/v2/jobs/all?page=1&batch=10' \
--header "X-Key: $REVENUEBASE_API_KEY"
{
"processes": [],
"page": 1,
"batch": 10,
"total": 0
}
Pagination and results
| Field or input | Meaning |
|---|---|
page | 1-based page number; default 1. |
batch | Jobs per page; default 10, maximum 100. |
total | Number of matching jobs, rather than emails. |
processes | Job records, each with a process_id, filename, status, message, and timestamps. |
total_emails, valid_emails, invalid_emails | Email counters on each job; values can be zero while processing. |
credits_used | Verification credits recorded for the job. Metadata has no surcharge. |
status to QUEUED, PROCESSING, COMPLETED, ERROR, CANCELLING, or CANCELLED to narrow the list.
Results are scoped to your own jobs. Increment page until you have read the total; new activity can change the list between requests. Save process_id instead of relying on a job’s position.
Next steps
Get a job’s status, cancel it, or download its output.Authorizations
Query Parameters
Page number (1-based).
Required range:
x >= 1Number of jobs per page.
Required range:
1 <= x <= 100When set, only jobs with this status are returned.
Available options:
QUEUED, PROCESSING, COMPLETED, ERROR, CANCELLING, CANCELLED Was this page helpful?
