Customers

List all customers

Retrieves the merchant's customers. All parameters are optional and can be combined; results are paginated.

get/v2/customers

Request

  • Base URL: https://test-api.kashier.io
  • URL: https://test-api.kashier.io/v2/customers
  • Auth: API key in header Authorization

Query parameters

pageinteger

Current page number.

limitinteger

Number of records per page.

searchstring

Search for a customer by name, phone number, or email address.

sortBystring

Field to sort by: customer name, phone number, or email address.

sortType1 | -1

Sorting direction: 1 = ascending, -1 = descending.

startDatestring

Only return customers created after this date. Example: 10-12-2024

endDatestring

Only return customers created before this date. Example: 10-12-2024

Response

The merchant's customers, with pagination info.

messagestring

Changes

No recorded changes to this operation across all 1 revision of this API.