List engagements for a payee

get

https://api.wingspan.app/v3/payments/payees/{payeeId}/engagements

List every engagement on this Payee relationship, whether the payer or the payee created it, with cursor-based pagination. status filters by the reader's own side.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

payeeId

string

required

^[A-Za-z0-9_.]{22,80}$

Query Params

filter

object

Filters use deep-object query parameters, for example filter[externalId][eq]=contract-123. externalId matches only engagements the payer created.

page

object

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

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

200Payee engagement list

400Malformed request syntax

401Unauthenticated

403Forbidden

404Resource not found