# Retrieve a list of customers

🚦 Rate Limit: 100 requests / minute

Endpoint: GET /customers
Version: 1.2.0
Security: BearerAuth

## Query parameters:

  - `modifiedFromDate` (string)
    Filter customers modified from this date (ISO 8601 format). Optional - if not provided, no date filtering is applied.
    Example: "2025-05-01T00:00:00Z"

  - `modifiedToDate` (string)
    Filter customers modified up to this date (ISO 8601 format). Cannot be specified without modifiedFromDate.
    Example: "2025-05-31T23:59:59Z"

  - `offset` (integer)
    Number of records to skip for pagination (default: 0)

  - `pageSize` (integer)
    Number of records to return per page (default: 1000, max: 1000)
    Example: 50

## Response 200 fields (application/json):

  - `data` (array)

  - `data.id` (string)
    Example: "f4a71b9d-17a9-4100-8110-46e133d6fc1b"

  - `data.first_name` (string)
    Example: "Dale"

  - `data.last_name` (string)
    Example: "Cooper"

  - `data.email` (string)
    Example: "dcooper@fbi.gov"

  - `data.phone` (string)
    Example: "+1-202-555-0123"

  - `data.shipping_preference_company` (string)
    Example: "USPS"

  - `data.total_orders` (string)
    Example: "23"

  - `data.total_spent` (number)
    Example: 2847.85

  - `data.average_order_value` (number)
    Example: 123.82

  - `data.date_of_birth` (string)
    Example: "1960-04-19"

  - `data.created_at` (string)
    Example: "2023-01-15T10:30:00Z"

  - `data.customer_type` (string)
    Example: "club_member"

  - `data.customer_tags` (string)
    Example: "VIP,Black Lodge"

  - `data.class` (string)
    Example: "Platinum"

  - `data.primary_card_expiry_date` (string)
    Example: "12/26"

  - `data.memberships` (string)
    Example: "Reserve Reds,White Lodge"

  - `data.has_password` (string)
    Example: "true"

  - `data.accepts_marketing` (string)
    Example: "true"

  - `data.note` (string)
    Example: "Prefers cherry pie with orders"

  - `data.addresses` (array)

  - `data.addresses.address_line1` (string)
    Example: "123 Twin Peaks Way"

  - `data.addresses.address_line2` (string)
    Example: "Apt 302"

  - `data.addresses.city` (string)
    Example: "Twin Peaks"

  - `data.addresses.state_name` (string)
    Example: "Washington"

  - `data.addresses.state_code` (string)
    Example: "WA"

  - `data.addresses.country_name` (string)
    Example: "United States"

  - `data.addresses.country_code` (string)
    Example: "US"

  - `data.addresses.zip_code` (string)
    Example: "98065"

  - `data.addresses.is_primary` (boolean)
    Example: true

  - `data.payment_methods` (array)

  - `data.payment_methods.last4` (string)
    Example: "1234"

  - `data.payment_methods.brand` (string)
    Example: "Visa"

  - `data.payment_methods.exp_month` (string)
    Example: "12"

  - `data.payment_methods.exp_year` (string)
    Example: "2026"

  - `data.payment_methods.billing_address` (object)

  - `data.payment_methods.billing_address.state` (string)
    Example: "Washington"

  - `data.payment_methods.billing_address.country` (string)
    Example: "United States"

  - `pagination` (object)

  - `pagination.current_offset` (integer)

  - `pagination.page_size` (integer)
    Example: 50

  - `pagination.total_records` (integer)
    Example: 1250

  - `pagination.total_pages` (integer)
    Example: 25

  - `pagination.current_page` (integer)
    Example: 1

  - `pagination.pages_remaining` (integer)
    Example: 24

  - `pagination.has_next_page` (boolean)
    Example: true

  - `pagination.has_previous_page` (boolean)