List recipients

The opaque metadata.nextCursor value from the previous page. It carries that page's filters, page size and ordering, so pass it on its own; see Pagination.

Number of items per page, from 1 to 100. The page size is carried inside metadata.nextCursor, so later pages keep the same size unless limit is passed again to change it.

Field to order the page by. Each value has its own default direction, used unless sortDirection is passed. See Sorting.

• createdAt (default) — descending
• name — ascending
• lastPaidAt — the most recent payment to the recipient, with recipients that have never been paid last; descending

Direction of the ordering selected by sort. When omitted, each sort value uses its own default; see Sorting.

Return only people (contact) or only businesses (vendor).

Include archived recipients. Defaults to false.