List Mercury Recipients
GET/api/mercury/recipients
Lists the payees mirrored from Mercury for a connection, with the SKU.io supplier each one is mapped to.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
Authentication: Requires Bearer token.
Filters: each column below can be filtered with filter[{column}.{operator}]=value, or combined into an AND/OR tree passed as base64-encoded JSON in filter_groups. Text operators: is, is_not, contains, does_not_contain, starts_with, ends_with, is_one_of, is_empty, is_not_empty. Numeric: is, greater_than, less_than, between. Date-time: before, after, between, today.
Filterable columns: id, supplier_id (numeric); name, email, status, default_payment_method, matched (mapped/unmapped), supplier_name (text); created_at, updated_at (date-time).
The plain search, matched and supplier_id query parameters are still accepted.
Request
Responses
- 200
- 401
- 403
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.