---
title: "Get Customers"
method: GET
path: "/Sites/{siteId}/Customers"
tags: ["Customers"]
---

# Get Customers

`GET /Sites/{siteId}/Customers`

## Path parameters

- `siteId` integer, required

## Query parameters

- `search` string
- `metadataKey` string[]
- `metadataValue` string[]
- `page` integer
- `pageSize` integer
- `orderBy` string
- `order` string

## Response `200`

Success

- QPilotCoreModelsPagedResultCustomerDto
  - `items` QPilotCoreModelsDtoEntitiesCustomerDto[], nullable
    - `created` string, date-time, nullable
    - `isShowingNotes` boolean, nullable
    - `isShowCoupons` boolean, nullable
    - `isProcessingPaused` boolean, nullable
    - `paymentMethods` QPilotCoreModelsDtoEntitiesPaymentMethodDto[], nullable
      - `id` integer
      - `status` 'Active' | 'Expired' | 'Revoked' | 'Invalid'
      - `createdUtc` string, date-time
      - `updatedUtc` string, date-time
      - `expirationDate` string, date-time, nullable
      - `customerId` string, required
      - `type` 'Stripe' | 'AuthorizeNet' | 'Test' | 'PayPal' | 'Braintree' | 'CyberSource' | 'Undefined' | 'Other' | 'Nmi' | 'PayaV1' | 'TrustCommerce' | 'Square' | 'Sage' | 'CyberSourceV2' | 'Checkout' | 'PaypalV2' | 'Shopify' | 'PayPalV3' | 'Airwallex'
      - `gatewayCustomerId` string, nullable
      - `gatewayPaymentId` string, nullable
      - `description` string, required
      - `expiration` string, nullable
      - `lastFourDigits` string, nullable
      - `billingFirstName` string, nullable
      - `billingLastName` string, nullable
      - `billingStreet1` string, nullable
      - `billingStreet2` string, nullable
      - `billingCity` string, nullable
      - `billingState` string, nullable
      - `billingPostcode` string, nullable
      - `billingCountry` string, nullable
      - `billingCompany` string, nullable
      - `isDefault` boolean, nullable
      - `gatewayPaymentType` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32
    - `id` string, required
    - `customerId` integer
    - `siteId` integer
    - `email` string, required
    - `firstName` string, nullable
    - `lastName` string, nullable
    - `shippingFirstName` string, nullable
    - `shippingLastName` string, nullable
    - `shippingStreet1` string, nullable
    - `shippingStreet2` string, nullable
    - `shippingCity` string, nullable
    - `shippingState` string, nullable
    - `shippingPostcode` string, nullable
    - `shippingCountry` string, nullable
    - `billingFirstName` string, nullable
    - `billingLastName` string, nullable
    - `billingStreet1` string, nullable
    - `billingStreet2` string, nullable
    - `billingCity` string, nullable
    - `billingState` string, nullable
    - `billingPostcode` string, nullable
    - `billingCountry` string, nullable
    - `phoneNumber` string, nullable
    - `company` string, nullable
    - `shippingCompany` string, nullable
    - `billingCompany` string, nullable
    - `lifetimeValue` number, double
    - `createdUtc` string, date-time
    - `updatedUtc` string, date-time
    - `metadata` object, nullable
  - `totalCount` integer
  - `totalPages` integer

---

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