GET /v1/customers
scope
read_customers
リクエストパラメーター
| 名前 | 位置 | 型 | 必須 | 説明 |
|---|---|---|---|---|
limit | クエリ | integer | 任意 | 1 回に返す件数(1〜100)。既定 20 |
offset | クエリ | integer | 任意 | 取得を開始する位置(0 始まり)。⚠️ 走査の途中でデータが更新されると取りこぼす。注文の増分取得には after_id と updated_since を使ってください |
レスポンスの例
{
"data": [
{
"id": "42",
"line_uid": "string",
"name": "山田太郎",
"avatar_url": "string",
"is_blocked": true
}
],
"pagination": {
"limit": 0,
"offset": 0,
"total": 0
}
}
解説
顧客を一覧取得します。LINE 識別(line_uid・表示名・画像・ブロック状態)のみで、氏名等の個人情報は含みません。
エラーレスポンスの例
{
"error": {
"code": "insufficient_scope",
"message": "requires scope 'read_customers'",
"request_id": "req_01H..."
}
}
返しうるエラー: 401 / 403