Sign in

v34

latestOpenAPI 3.1.0raw.githubusercontent.com2026-06-09194386949.7 KB
V2
Classify

List Classify Jobs

List classify jobs with optional filtering and pagination.

Filter by status, configuration_id, specific job_ids, or creation date range.

get/api/v2/classify

Query parameters

page_sizeinteger nullable

Number of items per page

Number of items per page

page_tokenstring nullable

Token for pagination

Token for pagination

status'PENDING' | 'RUNNING' | 'COMPLETED' | 'FAILED' nullable

Filter by job status

Filter by job status

job_idsstring[] nullable

Filter by specific job IDs

Filter by specific job IDs

project_idstring uuid nullable
organization_idstring uuid nullable
configuration_idstring nullable

Filter by configuration ID

Example:cfg-11111111-2222-3333-4444-555555555555

Filter by configuration ID

created_at_on_or_afterstring date-time nullable

Include items created at or after this timestamp (inclusive)

Include items created at or after this timestamp (inclusive)

created_at_on_or_beforestring date-time nullable

Include items created at or before this timestamp (inclusive)

Include items created at or before this timestamp (inclusive)

Cookies

sessionstring nullable

Response

Successful Response

next_page_tokenstring nullable

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

total_sizeinteger nullable

The total number of items available. This is only populated when specifically requested. The value may be an estimate and can be used for display purposes only.

Example response

{
  "items": [
    {
      "configuration": {
        "rules": [
          {
            "type": "invoice",
            "description": "contains invoice number, line items, and total amount"
          }
        ],
        "parsing_configuration": {
          "lang": "en",
          "target_pages": "1,3,5-7",
          "max_pages": 10
        }
      }
    }
  ]
}