# List customers

Used to fetch a paginated list of one or more Customers

Endpoint: GET /customers
Version: 1.1.0
Security: secretApiKeyAuth

## Query parameters:

  - `email` (string)
    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.
    Example: "example@mail.com"

  - `startTimestamp` (integer)
    The start timestamp (inclusive), it must be before the endTimestamp.
    Example: 1641859200

  - `endTimestamp` (integer)
    The timestamp when to return payment sessions up to (inclusive), it must be after the startTimestamp.
    Example: 1641945599

  - `ascending` (boolean)
    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.

  - `limit` (integer)
    Control how many items are return in a given page The max limit we allow is 25. The default is 10.
    Example: 10

  - `startsAfter` (string)
    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.
    Example: "cus_01FCTS1XMKH9FF43CAFA4CXT3P_1641912473"

## Response 200 fields (application/json):

  - `items` (array)

  - `items.id` (string)
    The ID of the customer
    Example: "cus_01G0EYVFR02KBBVE2YWQ8AKMGJ"

  - `items.email` (string)
    The customer's email address
    Example: "test@ryftpay.com"

  - `items.firstName` (string,null)
    The first name of the customer
    Example: "Jeff"

  - `items.lastName` (string,null)
    The last name of the customer
    Example: "Bridges"

  - `items.homePhoneNumber` (string,null)
    The home phone number of the customer. In E.164 format
    Example: "+447900000000"

  - `items.mobilePhoneNumber` (string,null)
    The mobile phone number of the customer. In E.164 format
    Example: "+447900000000"

  - `items.defaultPaymentMethod` (string,null)
    The Id of the customer's preferred/default payment method
    Example: "pmt_01G0EYVFR02KBBVE2YWQ8AKMGJ"

  - `items.metadata` (object,null)
    use this parameter to attach key-value data to the customer. These will be sent with any associated customer events on your webhooks. You can have a maximum of 5 pieces of metadata.
    Example: {"customerId":"1","registered":"123"}

  - `items.createdTimestamp` (integer)
    The epoch timestamp (seconds) when the customer was created
    Example: 1470989538

  - `paginationToken` (string,null)
    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: "cus_01FCTS1XMKH9FF43CAFA4CXT3P_1641912473"

## Response 400 fields (application/json):

  - `requestId` (string)
    Example: "b83f2653-06d7-44a9-a548-5825e8186004"

  - `code` (string)
    Example: "400"

  - `errors` (array)

  - `errors.message` (string)
    Example: "Required property 'amount' not found in JSON"

## Response 500 fields (application/json):

  - `requestId` (string)
    Example: "b83f2653-06d7-44a9-a548-5825e8186004"

  - `code` (string)
    Example: "400"

  - `errors` (array)

  - `errors.message` (string)
    Example: "Required property 'amount' not found in JSON"