---
title: "Get a list of customers."
method: GET
path: "/api/v1/customers"
tags: ["Customers"]
---

# Get a list of customers.

`GET /api/v1/customers`

## Query parameters

- `q` string
- `skip` integer
- `take` integer

## Response `200`

Success

- Customer[]
  - `firstName` string, nullable
  - `lastName` string, nullable
  - `customerId` string, uuid, required
  - `dateOfBirth` string, date-time, nullable
  - `gender` 'Male' | 'Female' | 'Other'
  - `phoneNumber` string, nullable
  - `address` MailingAddress
    - `address1` string, nullable
    - `address2` string, nullable
    - `address3` string, nullable
    - `address4` string, nullable
    - `address5` string, nullable
    - `city` string, nullable
    - `stateProvince` string, nullable
    - `postalCode` string, nullable
    - `country` string, nullable
  - `email` string, nullable
  - `driverLicenseState` string, nullable
  - `driverLicenseNumber` string, nullable
  - `pictureId` string, nullable
  - `parentIds` string[], nullable
  - `childIds` string[], nullable

---

[API](https://skmtc.dev/centeredge/apis/advantage-api.md) · [All operations](https://skmtc.dev/centeredge/apis/advantage-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/centeredge/advantage-api/revisions/00cc7dde429b/schema)