List payees
Retrieves a paginated list of payees with multiple optional filtering by email, name, creation date, status etc.
Success Responses
Error Responses
Authentication
x-api-keystring
RootPay API key sent in the x-api-key header. Keys are environment-scoped: live_* for production, test_* for sandbox.
Query parameters
cursor
Cursor for pagination. Use the next_cursor from the previous response to get the next page.
limit
Number of items to return per page. Minimum is 10. Maximum is 500.
email
Filter payees by email (case-insensitive partial match)
name
Filter payees by name (case-insensitive partial match)
has_default
Filter payees by whether they have a default payment method: true or false
created_at_gte
Return payees created on or after this date (YYYY-MM-DD).
created_at_lte
Return payees created on or before this date (YYYY-MM-DD).
order
Sort order by created_at: ‘asc’ for oldest first, ‘desc’ for newest first (default: ‘desc’)
Allowed values:
Response
List of payees retrieved successfully
data
has_more
total_count
next_cursor
previous_cursor