Skip to main content
GET
/
customers
列出客戶
curl --request GET \
  --url https://api.zangsho.com/v1/customers \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": 123,
      "email": "<string>",
      "name": "<string>",
      "phone": "<string>",
      "external_id": "<string>",
      "metadata": {},
      "ltv": "29800.00",
      "order_count": 123,
      "first_payment_at": "2023-11-07T05:31:56Z",
      "last_payment_at": "2023-11-07T05:31:56Z",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "meta": {
    "current_page": 123,
    "from": 123,
    "last_page": 123,
    "per_page": 123,
    "to": 123,
    "total": 123
  }
}

Authorizations

Authorization
string
header
required

使用 Laravel Sanctum Token 進行認證。

Token 可在商家後台的「API 設定」頁面取得。

Query Parameters

page
integer
default:1

頁碼

Required range: x >= 1
per_page
integer
default:20

每頁筆數(最大 100)

Required range: 1 <= x <= 100

搜尋 email 或 name(模糊比對)

Response

客戶列表

data
object[]
meta
object