List customers - hokan API v2

顧客一覧を取得します。

Request

Query Params

name

string

顧客名

optional

email_address

string

メールアドレス

optional

tel

integer

電話番号

optional

employee_code

string

社員コード

optional

birthday

string <date>

生年月日

optional

order

enum<string>

並び順

optional

Allowed values:

id-idcreated_at-created_atupdated_at-updated_at

page

integer

Page

optional

>= 1

Default:

Responses

🟢200OK

application/json

Body

data

array [anyOf]

Data

required

object (ExtIndividualCustomerSchema)

optional

object (ExtCorporateCustomerSchema)

optional

total

integer

Total

required

Example

{
  "data": [
    {
      "id": 0,
      "zip": "",
      "address": "",
      "address_kana": "",
      "tel": "",
      "fax": "",
      "email": "",
      "mobile": "",
      "mobile_email": "",
      "note": "",
      "outer_system_id": "",
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z",
      "name": "string",
      "name_kana": "string",
      "customer_type": "individual",
      "sales_status": "未設定",
      "person_in_charge_id": 0,
      "vice_person_in_charge_id": 0,
      "introducer_id": 0,
      "lead": {
        "id": 0,
        "name": "string",
        "disabled": false,
        "color_code": "string",
        "created_at": "2019-08-24T14:15:22Z",
        "updated_at": "2019-08-24T14:15:22Z",
        "category": "リーズ"
      },
      "extra_values": [
        {
          "internal_key": "string",
          "value": 0,
          "extra_item": {
            "id": 0,
            "name": "string",
            "internal_key": "string",
            "group_id": 0,
            "data_type": "Integer",
            "unit": "Age"
          }
        }
      ],
      "last_name": "string",
      "last_name_kana": "string",
      "first_name": "string",
      "first_name_kana": "string",
      "gender": "",
      "birthday": "2019-08-24",
      "annual_income": 0,
      "savings": 0,
      "living_expenses": 0,
      "industry": "string",
      "job": "string",
      "workplace": "string",
      "position": "string",
      "corporate_tel": "string",
      "corporate_email": "string",
      "corporate_mobile": "string",
      "card_exchanged_at": "2019-08-24",
      "death_date": "2019-08-24",
      "affiliation_name": "string",
      "affiliation_code": "string",
      "employee_code": "string"
    }
  ],
  "total": 0
}