Payments API ReferenceContact

Get all contacts

Returns a paginated list of contacts with optional filtering by search text and creation date

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path Parameters

organizationIdstringRequired
Organization ID
merchantIdstringRequired
Merchant ID

Headers

x-admin-api-keystringRequired

Query Parameters

pageSizedoubleOptional
Number of responses per page
pageNumberdoubleOptionalDefaults to 1
Page number
sortenumOptional

Ascending or descending order (by creation date)

Allowed values:
startDatedatetimeOptional
Filter by creation date
searchTextstringOptional
Search text for firstName, lastName, or externalId
countrySymbolenumOptional

Filter by country code (e.g., US, AR)

countrySymbolNotenumOptional

Filter by country code (not equals) (e.g., US, AR, CL)

Response

Paginated list of contacts retrieved successfully
contactslist of objects
Array of contacts
paginationobject
Pagination metadata

Errors