List engagement templates

get

https://api.wingspan.app/v3/payments/engagements

Lists Engagement templates for the authenticated payer with cursor-based pagination. pagination.totalSize is the count after applying the supplied filters, so callers can request Active and Archived tab counts.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

filter

object

Filters use deep-object query parameters, for example filter[accountIds][anyOf][]=acct_123.

page

object

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

sort

object

Sort by exactly one field using sort[name]=asc|desc or sort[updatedAt]=asc|desc.

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

200Engagement list

400Malformed request syntax

401Unauthenticated

403Forbidden

422Validation error