Search Batches

Searches your batches with filters, sorting and pages.

Requires the Read permission. See /docs/getting-started-with-search for the filter syntax.

Fields. filter and sort accept only id, referenceId, name, taxJurisdiction, defaultPaymentCategory,
archived, auditInfo.createdBy, auditInfo.updatedBy, auditInfo.createdAt and auditInfo.updatedAt. The batch ID field is
id.

Paging. pageSize is 10 to 1000 (default 100) and page × pageSize cannot exceed 10,000.

Errors

  • 400 VALIDATION_ERROR: a field is not in the list above, or a paging limit is exceeded (INVALID_PAGE_TOO_HIGH).
  • 400 INVALID_REQUEST: the search could not run. Check your filter syntax.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
object

Conditions a record must match. Omit to return every record. Use all for AND and any for OR; groups can be nested.

sort
array of objects

Sort order, applied in the order listed.

sort
number
10 to 1000
Defaults to 100

Records per page, between 10 and 1000. Defaults to 100. page × pageSize cannot exceed 10,000; narrow the filter to reach
older records.

number
≥ 1
Defaults to 1

Page to return, starting at 1. Defaults to 1.

Responses

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