Listing Batch Jobs
Listing batch jobs allows you to retrieve previously created batch requests. This is useful when you want to review completed jobs, monitor running batches, or locate a job ID for checking its status.
Batch Jobs Endpoint
Use the following endpoint to retrieve previously created batch jobs.
GET /v1/batch/jobsThe response returns a paginated list of batch jobs.
List Batch Jobs
Use the following request to retrieve your recent batch jobs.
Request
curl -X GET "https://scraper.geonode.io/v1/batch/jobs" \
-H "X-Api-Key: YOUR_API_KEY"Response
{
"jobs": [
{
"job_id": "9e60e068-b6ac-408d-aa6e-f120f41faf0d",
"status": "completed",
"accepted_urls": 3,
"completed_urls": 3,
"failed_urls": 0,
"config": {
"render_js": false,
"formats": [
"markdown"
],
"proxy": {
"country": null,
"type": "residential"
},
"headers": null,
"wait_config": null
},
"created_at": "2026-07-05T16:29:56.344150Z",
"completed_at": "2026-07-05T16:30:13.963398Z"
}
],
"page": 1,
"page_size": 10,
"page_count": 1
}Understanding the Response
Each batch job contains summary information about the processing request.
| Field | Description |
|---|---|
job_id | Unique identifier for the batch job. |
status | Current status of the batch job. |
accepted_urls | Number of valid URLs accepted when the batch was created. |
completed_urls | Number of URLs processed successfully. |
failed_urls | Number of URLs that failed during processing. |
config | Configuration used when the batch job was submitted. |
created_at | Time the batch job was created. |
completed_at | Time the batch job finished processing. |
The response also includes pagination information.
| Field | Description |
|---|---|
page | Current page number. |
page_size | Number of jobs returned per page. |
page_count | Total number of available pages. |
Filtering Batch Jobs
You can filter the returned jobs using query parameters.
| Query Parameter | Description |
|---|---|
status | Return only jobs with a specific status. |
start_date | Return jobs created on or after the specified date. |
end_date | Return jobs created on or before the specified date. |
page | Page number to retrieve. |
page_size | Number of jobs to return per page. |
Filter by Status
Retrieve only completed batch jobs.
curl -X GET "https://scraper.geonode.io/v1/batch/jobs?status=completed" \
-H "X-Api-Key: YOUR_API_KEY"Supported values:
queued
processing
completed
failed
cancelledFilter by Date Range
Retrieve jobs created within a specific time period.
curl -X GET "https://scraper.geonode.io/v1/batch/jobs?start_date=2026-07-01&end_date=2026-07-31" \
-H "X-Api-Key: YOUR_API_KEY"Pagination
Retrieve a specific page of results.
curl -X GET "https://scraper.geonode.io/v1/batch/jobs?page=2&page_size=10" \
-H "X-Api-Key: YOUR_API_KEY"Understanding Job Progress
The job summary makes it easy to see how a batch performed without retrieving the full job details.
| Scenario | Accepted URLs | Completed URLs | Failed URLs |
|---|---|---|---|
| All URLs processed successfully | 3 | 3 | 0 |
| One URL failed | 3 | 2 | 1 |
| Two URLs failed | 5 | 3 | 2 |
When to Use This Endpoint
Use this endpoint to:
- View recent batch activity.
- Find a previous batch job.
- Monitor completed or failed batches.
- Search jobs created within a specific date range.
- Retrieve a job ID before checking detailed status.
- Build dashboards or reporting tools.
Next Steps
Now that you know how to retrieve and filter batch jobs, continue to Cancelling Batch Jobs to learn how to stop a running batch job.