logo

List all jobs

Get a paginated list of jobs with filtering and sorting support

Get a paginated list of all scraping jobs for your account. Supports filtering by status and date range, and sorting by start time.

Query Parameters

ParameterTypeDefaultDescription
page_sizeinteger10Number of jobs per page (max 100)
pageinteger1Page number (minimum 1)
statusstringFilter by job status. Allowed values: queuing, queued, pending, rotating, success, error, canceled
start_fromstringRFC3339 timestamp. Returns jobs where start_time >= start_from. Example: 2025-01-01T00:00:00Z
start_tostringRFC3339 timestamp. Returns jobs where start_time <= start_to. Example: 2025-01-31T23:59:59Z
sortstringstart_time_descSort order. Allowed values: start_time_asc, start_time_desc

Timestamps are case-sensitive. Always use the RFC3339 format with uppercase T and Z (e.g. 2025-01-01T00:00:00Z). Invalid values for any filter parameter return 400 Bad Request.

Examples

# Get the 10 most recent jobs
curl 'https://q.scrape.do/api/v1/jobs' \
  --header 'X-Token: YOUR_TOKEN'

# Filter by status
curl 'https://q.scrape.do/api/v1/jobs?status=success' \
  --header 'X-Token: YOUR_TOKEN'

# Filter by date range
curl 'https://q.scrape.do/api/v1/jobs?start_from=2025-01-01T00:00:00Z&start_to=2025-01-31T23:59:59Z' \
  --header 'X-Token: YOUR_TOKEN'

# Sort oldest first, page 2
curl 'https://q.scrape.do/api/v1/jobs?sort=start_time_asc&page=2&page_size=25' \
  --header 'X-Token: YOUR_TOKEN'

# Combined: successful jobs this month, newest first
curl 'https://q.scrape.do/api/v1/jobs?status=success&start_from=2025-01-01T00:00:00Z&sort=start_time_desc' \
  --header 'X-Token: YOUR_TOKEN'

Response

{
  "Jobs": [
    {
      "JobID": "550e8400-e29b-41d4-a716-446655440000",
      "Status": "success",
      "TaskIDs": ["660e8400-e29b-41d4-a716-446655440001"],
      "StartTime": "2025-01-15T10:00:00Z",
      "EndTime": "2025-01-15T10:00:05Z"
    }
  ],
  "TotalCount": 150,
  "PageSize": 10,
  "PageNumber": 1,
  "TotalPages": 15
}

Job Status Values

StatusDescription
queuingJob is being prepared
queuedJob is in queue waiting to be processed
pendingJob is currently being processed
rotatingJob is retrying with different proxies
successJob completed successfully
errorJob failed
canceledJob was canceled

On this page