顧客一覧を取得

GET

/customers

Authorizations

bearerAuth

テナントに発行された個人アクセストークン（Laravel Sanctum）を
Authorization: Bearer {token} ヘッダーで送信してください。

Type

HTTP (bearer)

Parameters

Query Parameters

page

ページ番号（1始まり）

Type

integer

Minimum

1

Default

1

perPage

1ページあたりの件数

Type

integer

Minimum

1

Maximum

100

Default

20

email

メールアドレスの完全一致で絞り込み

Type

string

Format

"email"

status

ステータスで絞り込み

Type

string

Valid values

"ACTIVE""INACTIVE""WITHDRAWN"

Responses

顧客一覧

Content-Type

application/json

{

  

"data": [

  

  

{

  

  

  

"id": "01J8Z3K9Q6R7S8T9U0V1W2X3Y4",

  

  

  

"tenantId": "string",

  

  

  

"customerDomainId": "string",

  

  

  

"lineUserId": "string",

  

  

  

"salesforceContactRef": "string",

  

  

  

"status": "string",

  

  

  

"name": "山田 太郎",

  

  

  

"email": "string",

  

  

  

"company": "string",

  

  

  

"postcode": "string",

  

  

  

"address": "string",

  

  

  

"tel": "string",

  

  

  

"token": "string",

  

  

  

"isBlocked": true,

  

  

  

"customFields": [

  

  

  

  

{

  

  

  

  

  

"code": "member_rank",

  

  

  

  

  

"value": "ゴールド"

  

  

  

  

}

  

  

  

],

  

  

  

"createdAt": "string",

  

  

  

"updatedAt": "string",

  

  

  

"deletedAt": "string"

  

  

}

  

],

  

"meta": {

  

  

"currentPage": 1,

  

  

"perPage": 20,

  

  

"lastPage": 5,

  

  

"total": 96

  

}

}

GET

/customers

Playground

Authorization

bearerAuth

Variables

Key

Value

page

perPage

email

status

Samples

Powered by VitePress OpenAPI