v1

latestOpenAPI 3.0.32026-07-222085264.6 KB

Batch APIs

List batch jobs for the authenticated account

List your batch jobs, most recent first, with cursor-based pagination and optional status filtering. Job summaries carry the same fields as the job-status endpoint minus the download links — poll GET /batch/{batch_id} for a specific job to obtain its download_url.

The x-api-version header is not required on this endpoint.

get/batch

Query parameters

limitinteger

Example:2

Maximum number of jobs to return per page. Values outside 1-100 are clamped into range.

status'pending' | 'processing' | 'completed' | 'failed'

Example:completed

Return only jobs in this status. Any other value returns 400.

cursorstring uuid

Example:afb80886-2f90-45f9-a2c7-db407e227ca8

The next_cursor value from the previous page (the batch ID of that page's last job). Omit on the first page.

Response

Paginated list of batch jobs

next_cursorstring uuid nullable required

Batch ID to pass as cursor for the next page, or null when there are no more pages.

has_moreboolean required

Whether more jobs exist after this page.

Example response

{
  "jobs": [
    {
      "batch_id": "48b676de-f0d1-4ae5-af52-4e021991efe6",
      "status": "completed",
      "entity": "person",
      "action": "search",
      "identifier_count": 1,
      "result_count": 6,
      "entities_requested": 1,
      "entities_fulfilled": 6,
      "created_at": "2026-06-12T12:02:00.220799+00:00",
      "completed_at": "2026-06-12T12:02:01.816021+00:00"
    }
  ],
  "next_cursor": "afb80886-2f90-45f9-a2c7-db407e227ca8",
  "has_more": true
}