Sign in

v1

latestOpenAPI 3.0.32026-07-24148824715.6 KB
Batch Processing

Get the states for all batch processes

This endpoint will return a list of all batch processes that have been initiated, including their identifiers, status and errors.

You need one of the "View customers" or "View transactions" permissions to use this endpoint.

get/v2/batch-processing

Query parameters

page_numberinteger

One-based page index (1..N)

page_sizeinteger

The size of the page to be returned

sortstring[]

Sorting criteria in the format of: [-]property (- descending modifier).

  • Default sort order is ascending (without -).

  • Multiple sort criteria are supported.

statusstring[]
created_bystring[]
workflow_type'create-and-screen' | 'create-and-monitor' | 'manage-lookup-list' required

The workflow type for the batch process

The workflow type for the batch process

target_identifierstring uuid
Example:164dbbc6-d255-4854-9f1d-56f8474f2835

Filter by target identifier

Response

OK

firststring required

The URL path to the first page.

nextstring nullable

The URL path to the next page.

prevstring nullable

The URL path to the previous page.

selfstring required

The URL path to the current page.

total_countinteger nullable

Total number of items.