API Reference

Get a batch summary

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

Item progress counters for a Batch (progress.total / completed / failed), valid at any point in the batch's lifecycle. Pass expand=Breakdown to also populate breakdown — the type-specific rollup (for PayableImport: payable and deduction amounts and counts, payees impacted, new vs. updated resources). breakdown is the shape for this batch's type; there is no wrapping per-type key. It is null when not requested.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Query Params
expand
array of objects
expand
Allowed:
Headers
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

Updated 14 days ago

Did this page help you?
Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json

Updated 14 days ago

Did this page help you?