---
title: "List Customers"
method: GET
path: "/customers"
tags: ["Customers"]
---

# List Customers

`GET /customers`

Returns a paginated list of customers.

## Query parameters

- `cursor` string
- `limit` integer
- `created_from` string, date-time — Date & Time
- `created_to` string, date-time — Date & Time

## Response `200`

List of all customers

- CustomerList
  - `data` Customer[], required — List of customers.
    - `customerId` string, required — Unique Identification for the Customer
    - `merchantId` string, required — Thirteen character long identification provided to merchants by Moneris.
    - `createdAt` string, date-time, required — Time at which the object was created
    - `modifiedAt` string, date-time, nullable — Time at which the object was modified
    - `firstName` string, nullable — First name.
    - `middleName` string, nullable — Customer's middle name.
    - `lastName` string, nullable — Last name.
    - `companyName` string, nullable — Identifies the associated company name
    - `address` object, nullable — The postal address including street, town/city, province, and postal code. Optionally an unit number can be provided.
      - `unitNumber` string, nullable — Unit number
      - `streetNumber` string, nullable — Street number
      - `streetName` string, nullable — Street name
      - `city` string, nullable — Identifies the city.
      - `province` string, iso-3166-2, nullable — Province or state ISO 3166-2 code
      - `postalCode` string, nullable — Postal or zip code
      - `country` string, iso-3166, nullable — Provides the two letter country code according the ISO 3166-1 alpha-2 standard. For a complete list of country codes, visit: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2.
    - `shippingAddress` object, nullable — The postal address including street, town/city, province, and postal code. Optionally an unit number can be provided.
      - `unitNumber` string, nullable — Unit number
      - `streetNumber` string, nullable — Street number
      - `streetName` string, nullable — Street name
      - `city` string, nullable — Identifies the city.
      - `province` string, iso-3166-2, nullable — Province or state ISO 3166-2 code
      - `postalCode` string, nullable — Postal or zip code
      - `country` string, iso-3166, nullable — Provides the two letter country code according the ISO 3166-1 alpha-2 standard. For a complete list of country codes, visit: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2.
    - `phoneNumber` string, nullable — Phone number.
    - `email` string, email, nullable — Contains the customer's email address. For standard email protocols, visit: https://www.rfc-editor.org/rfc/rfc5322
    - `customData` CustomData, nullable — Merchant can send custom meta data with the transaction in this object. Moneris will echo these values back in response.
  - `self` string, uri-reference, nullable — Pagination link pointing to the current page.
  - `first` string, uri-reference, nullable — Pagination link pointing to the first page.
  - `last` string, uri-reference, nullable — Pagination link pointing to the last page.
  - `next` string, uri-reference, nullable — Pagination link pointing to the next page.
  - `previous` string, uri-reference, nullable — Pagination link pointing to the previous page.

## Other responses

- `400` — Bad Request.
- `401` — Not authorized. The user does not have a valid API Key or Access Token.
- `403` — Forbidden. The user does not have permission to access the requested resource.
- `429` — Too Many Requests
- `500` — Unexpected error.
- `503` — Service Temporarily Unavailable

---

[API](https://skmtc.net/moneris/apis/moneris-api.md) · [All operations](https://skmtc.net/moneris/apis/moneris-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/moneris/moneris-api/revisions/edefcc925b74/schema)