Skip to main content

GET /v1/customers

Scope

read_customers

Request parameters

NameInTypeRequiredDescription
limitqueryintegeroptionalHow many entries to return (1-100). Defaults to 20.
offsetqueryintegeroptionalZero-based offset to start from. ⚠️ Entries updated mid-scan can be missed. For incremental order fetching, use after_id with updated_since instead.

Response example

{
"data": [
{
"id": "42",
"line_uid": "string",
"name": "山田太郎",
"avatar_url": "string",
"is_blocked": true
}
],
"pagination": {
"limit": 0,
"offset": 0,
"total": 0
}
}

Description

List customers (LINE identity; classic PII excluded)

Error response example

{
"error": {
"code": "insufficient_scope",
"message": "requires scope 'read_customers'",
"request_id": "req_01H..."
}
}

Possible errors: 401 / 403