List Worker Report rows

get

https://api.wingspan.app/v3/reports/payees

Returns one Worker Report row per payee of the caller's account, with cursor-based pagination. With filter[includeDescendants]=true, also includes sub-accounts where the caller may run the Worker Report. pagination.totalSize is returned on the first page only. Profile and tax fields are omitted for payees who have not shared tax information with the caller. Tax identifiers are returned only as tinType and tinLastFour; for Individual rows tinLastFour is returned only to callers with Admin authority on the row's account. Account impersonation follows the session's bound subtree authority.

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

Filters use deep-object query parameters, for example filter[status][eq]=Activated. Omit status to return every payee regardless of status.

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 Worker Report rows

401Unauthenticated

403Forbidden

422Validation error