Skip to navigation

List payees

View as Markdown

Retrieves a paginated list of payees with multiple optional filtering by email, name, creation date, status etc.

Success Responses

Status CodeDescription
200OK - The list of payees was successfully retrieved

Error Responses

Status CodeError CodeDescription
400VALIDATION_ERRORThe provided query parameters failed validation
401AUTHENTICATION_ERRORAuthentication credentials are invalid or missing
403AUTHORIZATION_ERRORYou do not have permission to perform this action

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

cursorstring or nullOptional

Cursor for pagination. Use the next_cursor from the previous response to get the next page.

limitinteger or nullOptional10-500Defaults to 50
Number of items to return per page. Minimum is 10. Maximum is 500.
emailstring or nullOptional

Filter payees by email (case-insensitive partial match)

namestring or nullOptional

Filter payees by name (case-insensitive partial match)

has_defaultboolean or nullOptional

Filter payees by whether they have a default payment method: true or false

created_at_gtedatetime or nullOptional

Return payees created on or after this date (YYYY-MM-DD).

created_at_ltedatetime or nullOptional

Return payees created on or before this date (YYYY-MM-DD).

orderenum or nullOptionalDefaults to desc

Sort order by created_at: ‘asc’ for oldest first, ‘desc’ for newest first (default: ‘desc’)

Allowed values:

Response

List of payees retrieved successfully
datalist of objects
has_moreboolean
total_countinteger or nullOptional>=0Defaults to 0
next_cursorstring or nullOptional
previous_cursorstring or nullOptional