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

# Search customers

`GET /customers`

Return detailed information on specific customer criteria.

## Query parameters

- `customer_id` string
- `connection_id` integer
- `first_name` string
- `last_name` string
- `email` string
- `phone` string
- `ip_address` string
- `date_created_from` string, date-time
- `date_created_to` string, date-time
- `date_modified_from` string, date-time
- `date_modified_to` string, date-time
- `order_id` integer
- `campaign_id` integer
- `transaction_id` integer
- `offer_id` integer
- `order_offer_id` integer
- `status_type_id` null | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10, nullable — * `1` - Active * `2` - Cancelled * `3` - Complete * `4` - Partial * `5` - Declined * `6` - Archive * `7` - Rejected * `8` - Removed * `9` - Paused * `10` - Expired
- `is_recurring` boolean
- `merchant_id` integer
- `card_bin` integer
- `card_last_4` integer
- `is_blacklist` boolean
- `is_test` boolean
- `discount_code` string
- `ship_address` string
- `ship_city` string
- `ship_state` string
- `ship_zipcode` string
- `ship_country` string
- `bill_address` string
- `bill_city` string
- `bill_state` string
- `bill_zipcode` string
- `bill_country` string
- `shipment_id` integer
- `shipment_tracking_id` string
- `tracking1-20` string
- `with` 'customer_cards' | 'customer_addresses'
- `limit` integer
- `offset` integer
- `sort_by` string
- `order` 'asc' | 'desc'

## Response `200`

OK

- object
  - `total` integer
  - `customers` object[]
    - `customer_id` integer
    - `connection_customer_id` string, nullable
    - `connection_id` integer
    - `first_name` string
    - `last_name` string
    - `email` string
    - `ip_address` string
    - `phone` string
    - `birthday` string, date, nullable
    - `gender` string
    - `pronoun_id` null | 1 | 2 | 3 | 4, nullable — * `1` - he/him * `2` - she/her * `3` - they/them * `4` - rather not say
    - `active_subscriber` boolean
    - `is_blacklist` boolean
    - `is_fraud` boolean
    - `date_created` string, date-time
    - `date_modified` string, date-time
    - `created_by` integer
    - `modified_by` integer
    - `customer_notes` string, nullable
    - `tracking1` string, nullable
    - `tracking2` string, nullable
    - `tracking3` string, nullable
    - `tracking4` string, nullable
    - `tracking5` string, nullable
    - `tracking6` string, nullable
    - `tracking7` string, nullable
    - `tracking8` string, nullable
    - `tracking9` string, nullable
    - `tracking10` string, nullable
    - `tracking11` string, nullable
    - `tracking12` string, nullable
    - `tracking13` string, nullable
    - `tracking14` string, nullable
    - `tracking15` string, nullable
    - `tracking16` string, nullable
    - `tracking17` string, nullable
    - `tracking18` string, nullable
    - `tracking19` string, nullable
    - `tracking20` string, nullable
    - `customer_cards` object[]
      - `customer_card_id` integer
      - `card_type_id` null | 1 | 2 | 3 | 4 | 5 | 6 | 7, nullable — * `1` - Mastercard * `2` - Visa * `3` - Discover * `4` - American Express * `5` - Digital Wallet * `6` - ACH * `7` - SEPA
      - `card_number` string
      - `card_exp_month` integer
      - `card_exp_year` integer
      - `card_prepaid` boolean
      - `date_created` string, date-time
      - `date_modified` string, date-time
      - `created_by` integer
      - `modified_by` integer
    - `customer_addresses` object[]
      - `customer_address_id` integer
      - `fname` string
      - `lname` string
      - `organization` string
      - `address1` string
      - `address2` string
      - `city` string
      - `country` string
      - `state` string
      - `zipcode` string
      - `address_valid` boolean
      - `date_created` string, date-time
      - `date_modified` string, date-time
      - `created_by` integer
      - `modified_by` integer

## Other responses

- `401` — Unauthorized response
- `403` — Forbidden response
- `500` — Error response

---

[API](https://skmtc.net/vrio/apis/crm-configuration.md) · [All operations](https://skmtc.net/vrio/apis/crm-configuration/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/vrio/crm-configuration/versions/62037010356e/schema)