Sign in

v1

latestOpenAPI 3.0.02026-08-0696238481.7 KB
Customers

List customers

Used to fetch a paginated list of one or more Customers

get/customers

Query parameters

emailstring
Example:example@mail.com

A case insensitive email to search by. Note that emails are unique per Customer so you can expect a single item within the response. Any other query parameters will be ignored if this is provided.

startTimestampinteger
Example:1641859200

The start timestamp (inclusive), it must be before the endTimestamp.

endTimestampinteger
Example:1641945599

The timestamp when to return payment sessions up to (inclusive), it must be after the startTimestamp.

ascendingboolean

Control the order (newest or oldest) in which the items are returned. false will arrange the results with newest first, whereas true shows oldest first. The default is false.

limitinteger
Example:10

Control how many items are return in a given page The max limit we allow is 25. The default is 10.

startsAfterstring
Example:cus_01FCTS1XMKH9FF43CAFA4CXT3P_1641912473

A token to identify where to resume a subsequent paginated query. The value of the paginationToken field from that response should be supplied here, to retrieve the next page of results for that timestamp range.

Response

Successfully retrieved the customers

paginationTokenstring nullable

A token to use for getting the next page of results - send the same request with this value in the 'paginationToken' query parameter. This field is null when there are no further items to return

Example response

{
  "items": [
    {
      "id": "cus_01G0EYVFR02KBBVE2YWQ8AKMGJ",
      "email": "test@ryftpay.com",
      "firstName": "Jeff",
      "lastName": "Bridges",
      "homePhoneNumber": "+447900000000",
      "mobilePhoneNumber": "+447900000000",
      "defaultPaymentMethod": "pmt_01G0EYVFR02KBBVE2YWQ8AKMGJ",
      "metadata": {
        "customerId": "1",
        "registered": "123"
      },
      "createdTimestamp": 1470989538
    }
  ],
  "paginationToken": "cus_01FCTS1XMKH9FF43CAFA4CXT3P_1641912473"
}