# Get list of customers

Get list of customers

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

## Security:

  - `bearer` (unknown)
    http bearer JWT

  - `basic` (unknown)
    http basic

  - `apiKey` (unknown)
    apiKey in header X-API-Key

## Query parameters:

  - `page` (integer, required)
    Specifies page number

  - `createdFrom` (string)
    The createdAt date from witch the customers will be fetched

  - `createdTo` (string)
    The createdAt date to witch the customers will be fetched

  - `merchantCustomerId` (string)
    The merchant customer id

  - `email` (string)
    The email address

  - `phoneCountry` (string)
    The phone country code

  - `phoneNumber` (string)
    The phone number

## Response 200:

  - `200` (unknown)
    Customers successfully retrieved

## 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)

  - `data.phone.countryCode` (string)
    Area or country code of the phone number of the customer. Present if passed by merchant in Payment.

  - `data.phone.number` (string)
    Phone number of the customer. Present if passed by merchant in Payment.

  - `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:

  - `500` (unknown)
    Internal Server Error

## Response 500 fields (application/json):

  - `type` (string)

  - `title` (string)

  - `status` (string)

  - `detail` (string)

  - `instance` (string)

## Response 200 examples:

  - `Default` (unknown)

