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.

Query Params
integer
≥ 1
Defaults to 1

One-based page index (1..N)

integer
≥ 1
Defaults to 25

The size of the page to be returned

sort
array of strings
Defaults to []

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

  • Default sort order is ascending (without -).

  • Multiple sort criteria are supported.

sort
status
array of strings
status
created_by
array of uuids
created_by
string
enum
required
Defaults to create-and-screen

The workflow type for the batch process

Allowed:
uuid

Filter by target identifier

Response

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json