Search payee rows

get

https://api.wingspan.app/v3/search/payee-rows

Query the payer-seat search rows. All filters — equality included — execute inside the Atlas $search pipeline against the materialized row collection; this endpoint never touches the operational database. When filter[searchString][eq] is present, results are relevance-ranked (searchScore descending) with any explicit sort[field] applied as the secondary sort; when absent, default sort is events.createdAt descending. Account scope is enforced server-side as non-negotiable filter clauses; there is no filter[accountIds] — target a child account via X-Wingspan-Account. Set filter[includeDescendants]=true to include rows of the descendant Accounts you may access. It can't be combined with page[mode]=materialized or page[resultSetId].

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

page

object

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

sort

object

QueryQL sort namespace, sort[field]=asc|desc — exactly one field. Sort keys address the row's events.* timestamps. When filter[searchString][eq] is present, relevance (searchScore descending) is the primary sort and the requested field becomes the secondary sort.

filter

object

QueryQL filter namespace. Serialize as filter[field][operator]=value; for array operators use filter[field][anyOf][]=value. x-legacy-filter names the legacy /search/payee-row filter each field replaces.

Dynamic paths are accepted in addition to the named fields: filter[customFields.<key>][op] (payer-owned custom fields; legacy payerOwnedData.customFields.<key>) and filter[metadata.<key>][op] (legacy labels). Supported operators on dynamic paths: eq, ne, anyOf, noneOf, contains. Values must be non-empty strings (send booleans as "true"/"false"). Tenant-defined keys are text-analyzed in the search index, so dynamic-path matching is analyzed term matching (case-insensitive; the value's terms must all appear), not strict string equality — and contains coincides with eq. For multi-select (value-set) custom fields, a row matches when any selected value matches: use anyOf to match any of several values. An unknown customFields.<key> is accepted (no 422) but matches no rows — the predicate narrows to an empty result set rather than being ignored.

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 row search results

400Malformed request syntax

401Unauthenticated

403Forbidden

422Validation error