# Get list of customers

Get list of customers

Endpoint: GET /customers
Version: 2.5.0
Security: bearer, basic, apiKey

## Query parameters:

  - `page` (integer, required)
    Specifies page number
    Example: 2

  - `createdFrom` (string)
    The createdAt date from witch the customers will be fetched
    Example: "2025-05-12"

  - `createdTo` (string)
    The createdAt date to witch the customers will be fetched
    Example: "2025-05-15"

  - `merchantCustomerId` (string)
    The merchant customer id
    Example: "Test_Merchant"

  - `email` (string)
    The email address
    Example: "test@gmail.com"

  - `phoneCountry` (string)
    The phone country code
    Example: 33

  - `phoneNumber` (string)
    The phone number
    Example: 98746321

## Response 200 fields (application/json):

  - `totalNumberOfPages` (integer)
    Indicates total number of pages that exist.

  - `totalNumberOfItems` (integer)
    Indicates total number of items that exist.

  - `page` (integer)
    Indicates number of page that is retrieved.

  - `pageSize` (integer)
    Indicates max number of items on page.

  - `data` (array)

  - `data.id` (string)
    Unique identifier of the customer assigned by Paygate.

  - `data.merchantCustomerId` (string)
    Unique identifier of the customer assigned by merchant.

  - `data.firstName` (string)
    First name of the customer. Present if passed by merchant in Payment.

  - `data.lastName` (string)
    Last name of the customer. Present if passed by merchant in Payment.

  - `data.companyName` (string)
    Last name of the customer. Present if passed by merchant in Payment.

  - `data.email` (string)
    E-mail address of the customer. Present if passed by merchant in Payment.

  - `data.phone` (object)
    Phone number of the customer.

  - `data.phone.countryCode` (string)
    Country Code/Area code of the phone number. Allows up to 3 digits. Must not contain the '+' prefix.

  - `data.phone.number` (string)
    Phone number of the customer.

  - `data.scope` (string)
    Scope of customer vault. Present if configured for the merchant in MAT.

  - `data.createdAt` (any)
    Creation date and time in ISO 8601 format.

  - `data.updatedAt` (any)
    Update date and time in ISO 8601 format.

## Response 500 fields (application/json):

  - `type` (string)

  - `title` (string)

  - `status` (string)

  - `detail` (string)

  - `instance` (string)