Skip to main content

GET /v1/customers/{id}

Scope​

read_customers

Request parameters​

NameInTypeRequiredDescription
idpathintegeroptional

Response example​

{
  "data": {
    "id": "42",
    "line_uid": "string",
    "name": "山田太郎",
    "avatar_url": "string",
    "is_blocked": true,
    "profile": {
      "last_name": "string",
      "first_name": "string",
      "zip": "string",
      "pref": "string",
      "city": "string",
      "address_1": "string",
      "address_2": "string",
      "tel": "string",
      "email": "string",
      "gender": "male"
    }
  }
}

Description​

Get a customer (PII profile gated by read_customers_pii)

Error response example​

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

Possible errors: 401 / 403 / 404