List batches

get

https://api.wingspan.app/v3/platform/batches

Returns a paginated list of Batches of one type; filter[type][eq] is required. filter[status][anyOf][], filter[accountId][anyOf][] and the inclusive filter[createdAt][gte] / filter[createdAt][lte] range narrow the result; omitting accountId lists the caller's own Account. pagination.totalSize is the number of matching Batches.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

page

object

Pagination query parameters. Serializes as page[size] and page[token].

filter

object

Deep-object filters, for example filter[type][eq]=PayableImport. filter[type][eq] is required. For array operators use filter[field][anyOf][]=value.

Headers

X-Wingspan-Account

string

^(?:[A-Za-z0-9_.]{22}|[a-f0-9]{24})$

Select the Account for an Account-scoped operation. A direct ServiceAccount API key MUST supply this header, and the target must be within the ServiceAccount owner's or Authorization grant's Account boundary. A Person bearer may select an Account on which it has an active Stakeholder, and an Account session may select its bound Account (or a descendant only when the session explicitly includes descendants).

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/problem+json

200Paginated list of batches

401Unauthenticated

403Forbidden

422Validation error