Logoelepay
Customer

List customers

カスタマ情報を一覧で取得します。

GET
/customers

Authorization

AuthorizationBearer <token>

API呼出すの認証は、秘密鍵を認証トークンとして扱い、Bearer 認証経由で行われます。 秘密鍵は、全ての API リクエスト操作が可能となる重要なキーなので、取扱いにご注意ください。

In: header

Query Parameters

keyword?string

キーワード

limit?integer

最大件数

Default20
Rangevalue <= 100
offset?integer

検索開始位置

Default0

Response Body

application/json;charset=utf-8

curl -X GET "https://api.elepay.io/customers"
{
  "total": 0,
  "customers": [
    {
      "id": "string",
      "object": "customer",
      "liveMode": true,
      "defaultSource": "string",
      "name": "string",
      "description": "string",
      "email": "string",
      "phone": "string",
      "remark": "string",
      "operator": "string",
      "status": "active",
      "metadata": {
        "property1": "string",
        "property2": "string"
      },
      "updateTime": 0
    }
  ]
}