# Get customers

> GET /v1/customers

Source: https://docs.trykintsugi.com/reference/get-customers

API version: v1 (legacy API)

GET /v1/customers

Get customers

The Get Customers API retrieves
    a paginated list of customers based on specified filters.
    This API allows searching, filtering by country and state, and sorting the results.

Category: Customers

Query parameters:
search_query (string) - Search term to filter customers by name or other details
country (CountryCodeEnum | string[]) - Country code in ISO 3166-1 alpha-2 format (e.g., 'US')
  allowed values: AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM (and 239 more, see the reference page)
state (string) - State or province code to filter customers
source__in (string) - Filter customers by source (comma-separated)
  allowed values: SHOPIFY, API
connection_id__in (string) - Filter customers by connection ID (comma-separated)
  allowed values: conn_abc123, conn_def456
order_by (string) - Comma-separated list of fields to sort results by.
  allowed values: created_at, street_1, street_2, city, state, postal_code, country, status
page (integer)
size (integer)

Response fields:
items (CustomerRead[], required)
  phone (string) - Customer's phone number
  street_1 (string) - Primary street address.
  street_2 (string) - Additional street address details, such as an apartment or suite number.
  city (string) - City where the customer resides.
  county (string) - County or district of the customer.
  state (string) - State or province of the customer.
  postal_code (string) - ZIP or Postal code of the customer.
  country (CountryCodeEnum) - Country code in ISO 3166-1 alpha-2 format
    allowed values: AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM (and 239 more, see the reference page)
  full_address (string) - Complete address string of the customer, which can be used as an alternative to individual fields.
  name (string) - Name of the customer.
  external_id (string) - External identifier associated with the customer.
  status (StatusEnum) - Status of the customer.
    allowed values: ACTIVE, ARCHIVED
  email (string) - Customer's email address
  company_name (string) - Registered or legal business name of the customer.
  source (SourceEnum) - Source of the customer's record.
    allowed values: BIGCOMMERCE, BESTBUY, BUNNY, CHARGEBEE, SHOPIFY, SHOPLINE, ECWID, STRIPE, AMAZON, TIKTOK, CUSTOM, UNKNOWN (and 69 more, see the reference page)
[truncated, see the reference page]

---

Index of every page: https://docs.trykintsugi.com/llms.txt