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

# Search for customers

`GET /customers`

## Request

- Base URL: `https://api.c1st.com/api`
- URL: `https://api.c1st.com/api/customers`
- Auth: HTTP bearer

Lists customers of the authenticated store, optionally filtered and paginated. Drafts and deleted customers are excluded by default. Returns 400 for an unsupported `sortField` or an invalid request.

## Query parameters

- `paginationStart` integer
- `paginationPageLength` integer
- `count` boolean
- `sortOrder` -1 | 1
- `customerno` string
- `sortField` string
- `allowMarketing` boolean
- `name` string
- `email` string
- `phoneno` string
- `ean` string
- `barcode` string
- `cvr` string
- `tags` string
- `tag` integer
- `ids` string
- `freetext` string
- `partOfLoyaltyClub` boolean
- `updated_after` string

## Response `200`

Ok

- SearchCustomerResponse: The representation of a customer search.
  - `content` Customer[]
    - `id` integer: A unique customer ID
    - `storeid` integer: ID for the store for which the customer is associated
    - `createddate` string, nullable
    - `name` string, nullable: The name of the customer.
    - `phone` string, nullable: The phone number of the customer. Should start with country code, like +45. If not, assume +45.
    - `phone_e164` string, nullable: Phone number in E.164 format, might sometimes be the same as "phone" but this field is guaranteed to be in E.164 format
    - `country` string, nullable: The country of the phone number. Must be in format ISO 3166-1 alpha-2.
    - `email` string, nullable: The email of the customer.
    - `barcode` string, nullable: Barcode used for POS customer lookup via barcode scanning.
    - `address` string, nullable: The address of the customer.
    - `city` string, nullable: The city of the customer.
    - `zipcode` string, nullable: The zip code of the customer.
    - `addr_country` string, nullable: The country of the customers address.
    - `lat` number, double, nullable: The latitude of the customer.
    - `lng` number, double, nullable: The longitude of the customer.
    - `birthdate` string, nullable
    - `ean` string, nullable: The EAN number associated with the customer. Must be a valid EAN.
    - `vat` string, nullable: The VAT/CVR number associated with the customer.
    - `customerno` string, nullable: The customer-number associated with the customer.
    - `economic_customernumber` integer, nullable: The e-conomic number of the customer.
    - `balance` number, nullable: The customer's balance
    - `note` string, nullable: A note about the customer.
    - `draft` integer: Whether or not the customer is in draft mode
    - `deleted` integer: Whether or not the customer is deleted
    - `tags` CustomerTag[], nullable: Tags associated with the customer.
      - `title` string, required: The title of the tag
      - `id` integer, nullable: The id of the tag
      - `handle` string, nullable: Unique handle for the produttag. Will be set automatically if not set. This value cannot be changed once set.
      - `color` string, nullable: The color used when displaying the tag in the app
    - `permission_marketing` string, nullable: Timestamp for if when the permission has been granted. `null` if permission hasn't been granted.
    - `updated_at` string, nullable: Timestamp for when the last time the customer is updated.
    - `deleted_at` string, nullable: Timestamp for when the last time the customer is deleted.
    - `loyaltypointsbalance` number, nullable: The customers loyalty point balance
    - `loyalty_member_since` string, nullable: Datetime of when the customer joined the loyalty club. If null, the customer is not part of the loyalty club
    - `loyalty_member_id` number, nullable: Assigned loyalty membership ID when the customer joined the loyalty club. If null, the customer is not part of the loyalty club
    - `shopify_customer_id` number, nullable: The corresponding ShopifyCustomerId if customer is syncronized with Shopify
    - `store` object: Name of partner store that customer is registered in. requires scope 'customerlookup'
      - `id` integer: Store id
      - `title` string: Store title
  - `count` integer, nullable: The total number of customers found by the query if ignoring pagination. Only present if `count` was specified in the query parameter.
  - `hasMore` boolean: True if there are more customers to receive than the current pagination allowed.

## Other responses

- `400`: Bad request, e.g. unsupported `sortField`

---

[API](https://skmtc.dev/c1st/apis/customers-1st-api.md) - [All operations](https://skmtc.dev/c1st/apis/customers-1st-api/llms.txt) - [OpenAPI document](https://skmtc.dev/c1st/apis/customers-1st-api/revisions/4250bb326f2a?raw)