List recipients (merchant-scoped)

List the recipients that belong to a merchant.

Merchant users work on their own merchant's recipients. Tenant owners and admins can work on any merchant in their tenant by passing ?merchantId=. A merchant in another tenant returns 404. Other roles are refused.

Authenticate with a dashboard session token, or a merchant-pinned secret key in X-API-Key. A secret key acts only for its own merchant: anything it creates belongs to that merchant and records the key as the actor, and another merchant's recipients return 404. Publishable, payout_write and agent_onboarding keys are refused.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
uuid

Tenant admin/owner override — target merchant within the caller's tenant (UUID). Required for tenant_admin/tenant_owner; ignored for role merchant (scope comes from JWT).

string
enum

Filter by recipient status. Only active/inactive accepted here; gateway_locked is system-reserved.

Allowed:

Free-text search on name/email (max 200 chars).

integer
≥ 1

Page number (default 1).

integer
1 to 500

Page size.

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json