Skip to navigation

List payers

View as Markdown

Retrieve a paginated list of all payers in your organization.

Filtering Options

You can filter the results using:

  • email: Find payers by email (partial, case-insensitive match)
  • name: Find payers by name (partial, case-insensitive match)
  • has_default: Filter by whether payer has a default payment method
  • created_at_gte: Return payers created on or after a specific date
  • created_at_lte: Return payers created on or before a specific date

Pagination

Results are paginated using cursor-based pagination:

  • limit: Number of results per page (default: 50, min: 10, max: 500)
  • cursor: Use the next_cursor from the previous response to get the next page
  • order: Sort by creation date (asc for oldest first, desc for newest first)

Response

Returns a paginated response containing:

  • Array of payer objects
  • Pagination metadata (has_more, next_cursor, previous_cursor)
  • Total count of matching results

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 payers by email (case-insensitive partial match)

namestring or nullOptional

Filter payers by name (case-insensitive partial match)

has_defaultboolean or nullOptional

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

created_at_gtedatetime or nullOptional

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

created_at_ltedatetime or nullOptional

Return payers 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 payers retrieved successfully
datalist of objects
has_moreboolean
total_countinteger or nullOptional>=0Defaults to 0
next_cursorstring or nullOptional
previous_cursorstring or nullOptional