---
title: "Customer list"
method: GET
path: "/shops/{SHOP_ID}/customers"
tags: ["Customer"]
---

# Customer list

`GET /shops/{SHOP_ID}/customers`

Get list of customers

## Path parameters

- `SHOP_ID` integer, required

## Query parameters

- `page_size` integer
- `page_number` integer
- `search` string
- `start_time_inserted_at` integer
- `end_time_inserted_at` integer
- `start_time_updated_at` integer
- `end_time_updated_at` integer
- `customer_ids` string
- `selectedLevel[]` string[]

## Response `200`

Success

- object
  - `data` Customer[] — List of customers
    - `id` string — Customer ID
    - `name` string — Full name
    - `gender` string — Gender
    - `emails` string[] — Email addresses
    - `phone_numbers` string[] — Phone numbers
    - `pages_customers` object[] — Customer's linked pages
      - `id` string — Page ID
      - `name` string — Page name
      - `platform` string — Platform
    - `date_of_birth` string, date — Date of birth
    - `reward_point` number — Reward point
    - `is_discount_by_level` boolean — Discount based on level
    - `tags` string[] — Customer tags
    - `is_block` boolean — Block customer
    - `assigned_user_id` string — Assigned employee ID
    - `level_id` string — Customer level ID
    - `notes` object[] — Customer notes
      - `id` string — Note ID
      - `message` string — Note content
      - `images` object[] — Note images
        - `url` string, uri
    - `shop_customer_address` object[] — Customer addresses
      - `id` string — Address ID (include to update, omit to create new)
      - `country_code` integer — Country code
      - `province_id` string — Province ID
      - `district_id` string — District ID
      - `commune_id` string — Commune ID
      - `address` string — Address
      - `full_address` string — Full address
      - `full_name` string — Recipient name
      - `phone_number` string — Phone number
    - `order_count` integer — Order count
    - `purchased_amount` integer — Purchased amount
    - `succeed_order_count` integer — Succeed order count
    - `last_order_at` string, date-time — Last order at
    - `conversation_link` string, uri — Conversation link
    - `referral_code` string — Referral code
    - `fb_id` string — Facebook ID
    - `customer_id` string — Customer ID
  - `page_number` integer — Page number
  - `page_size` integer — Page size
  - `success` boolean — Success status
  - `total_entries` integer — Total entries
  - `total_pages` integer — Total pages

---

[API](https://skmtc.dev/pancake/apis/pancake-pos-open-api.md) · [All operations](https://skmtc.dev/pancake/apis/pancake-pos-open-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/pancake/pancake-pos-open-api/revisions/acb70aa4b3f5/schema)