API references
Search documentation... ⌘K
API references
Open merchant dashboard
Merchant API
All our references

Filter Contacts

Returns a paginated list of contacts for the authenticated merchant with filtering capabilities.

Filter by name, email, mobile (substring match) and creation date. Free-text terms also matches contact ID and external ID. Results are ordered by creation date descending.

Endpoint signature
This endpoint requires an API key. Read our authentication guide for more information.
POST https://api.reservepay.com/merchants/filter-contacts HTTP/1.1
Content-Type: application/json
Accept: application/json
Authorization: Bearer <token>
{
per_page: number?,
page: number?,
name: string?,
email: string?,
mobile: string?,
terms: string?,
created_at: string?,
}
Returns: object
New to Reservepay? Read our guide on how to call endpoints to get started. Note that this endpoint returns a paginated response, see the Pagination section of the same guide.
Request arguments
per_page number

Optional. Number of contacts to return per page. Default: 10, Maximum: 100

page number

Optional. Page number for pagination. Default: 1 (first page)

name string

Optional. Filter by contact name (substring, case-insensitive).

email string

Optional. Filter by contact email (substring, case-insensitive).

mobile string

Optional. Filter by contact mobile (substring).

terms string

Optional. Free-text search across contact name, email, mobile, contact ID, and external ID (substring, case-insensitive).

created_at string

Optional. Filter by creation date. Supports: specific date (YYYY-MM-DD), date range (YYYY-MM-DD..YYYY-MM-DD), or keywords (today, yesterday, this_week, last_week, this_month, last_month).

Response attributes
Attribute Description
previous
object

Pagination for the previous page. Contains 'before' (page number) and 'per_page' (page size) parameters. Use these values in the 'page' and 'per_page' parameters of the next request to get the previous page. Returns null if there is no previous page.
page
array

The current page of records, ordered by creation date (newest first). Each record is serialized according to the specified record_serializer option.
next
object

Pagination for the next page. Contains 'after' (page number) and 'per_page' (page size) parameters. Use these values in the 'page' and 'per_page' parameters of the next request to get the next page. Returns null if there is no next page.
Errors common to all endpoints
UNHANDLED_ERROR

This error occurs when the server encounters an unexpected internal error that it cannot handle gracefully. This typically happens due to bugs, infrastructure issues, or edge cases that weren't anticipated during development.

INVALID_ARGUMENTS

This error occurs when the request contains invalid or missing parameters. Common cases include missing required fields, or values that don't match the expected format or type.

BAD_VERSION

This error occurs when making requests to an API version that does not exist. This commonly happens when using an outdated SDK or when the API version specified in the request URL is incorrect.

CODE SAMPLES
curl
Learn how to run these code samples in your terminal by reading our guide.