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

List all Contacts

Returns contacts for the authenticated merchant.

When called without pagination params (per_page, after, before), responds with a flat array of contacts for backward compatibility.

When any pagination param is provided, responds with a cursor-paginated page object containing page, next, and previous cursors.

Endpoint signature
This endpoint requires an API key. Read our authentication guide for more information.
POST https://api.reservepay.com/merchants/list-contacts HTTP/1.1
Content-Type: application/json
Accept: application/json
Authorization: Bearer <token>
{
per_page: number?,
after: string?,
before: 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 (enables paginated response).

after string

Optional. Cursor for pagination - return contacts created before this contact ID.

before string

Optional. Cursor for pagination - return contacts created after this contact ID.

Response attributes
Attribute Description
contact_id
string

The internal unique identifier for the contact.
external_id
string

Nullable. The external ID provided when the contact was created.
email
string

Nullable. The email address of the contact.
mobile
string

Nullable. The mobile number of the contact.
name
string

Nullable. The name of the contact.
favorite
boolean

Whether the contact is marked as a favorite.
created_at
number

The Unix timestamp (seconds since epoch) when the contact was created.
primary_bank_account
object

Nullable. The primary bank account for the contact.
default_card
object

Nullable. The default card for the contact.
bank_accounts
array

The most recent bank accounts associated with the contact (limited to 25 most recent, ordered by creation date descending).
cards
array

The most recent cards associated with the contact (limited to 25 most recent, ordered by creation date descending).
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.