😀客戶

列表

透過 GET 請求取得ㄎ清單,並可依據下列查詢參數進行過濾、排序與分頁。

GET https://{API_HOST}/api/v1/contact

根據下方的 Query Parameters 參數進行過濾篩選。

curl -X GET
    -H "Content-Type: application/json"
    https://{API_HOST}/api/v1/contact

Query Parameters

名稱
類型
必填
說明
範例

page

integer

當前頁碼(從 1 開始)

page=2

search

string

名字關鍵字搜尋

search=John

created_at__start

string (datetime)

建立時間(起)

created_at__start=2023-01-01

created_at__end

string (datetime)

建立時間(迄)

created_at__end=2023-12-31

birth_months

array<integer>

出生月份(1–12)

birth_months=1,2

membership_no

string

會員編號

membership_no=123456

sponsor_id

string

業主 ID

sponsor_id=999

company_ids

array<integer>

公司 ID

company_ids=1,2,3

tag_ids

array<integer>

標籤 ID 清單

tag_ids=101,102

identity_no

string

身份證號碼

identity_no=A123456789

phone_number

string

電話號碼

phone_number=0912345678

age__start

integer

年齡(起)

age__start=20

age__end

integer

年齡(迄)

age__end=40

has_duplicate_number

boolean (0/1)

是否有重複號碼

has_duplicate_number=1

has_number

boolean (0/1)

是否有電話號碼

has_number=1

has_fb_optin

boolean (0/1)

是否有 FB 授權

has_fb_optin=1

has_valid_fb_optin

boolean (0/1)

是否有有效 FB 授權

has_valid_fb_optin=1

has_disturb

boolean (0/1)

是否有勿擾資料

has_disturb=1

Response

PROPERTY

TYPE

DESCRIPTION

data

Array of objects

客戶資料陣列

meta

Object

頁籤資訊

取得

URL Parameters

PARAMETER

REQUIRED

DEFAULT

TYPE

DESCRIPTION

contact

True

NULL

Number

客戶的 ID

Response

請參考客戶arrow-up-right回應格式。

PROPERTY

TYPE

DESCRIPTION

新增

根據下方的 Query Parameters 表單的參數進行建立。

Query Parameters

PARAMETER

REQUIRED

DEFAULT

TYPE

DESCRIPTION

membership_no

false

NULL

String

會員編號

identity_no

false

NULL

String

身分證

gender

false

NULL

Number

性別 0: 女 1: 男

first_name

true

NULL

String

last_name

false

NULL

String

birth_at

false

NULL

Date

出生日期

cz_cols

false

NULL

Array

自訂欄位,參數型態參考下方 CzCol 表格說明

company_ids

false

NULL

Array

公司系統編號

Response

請參考客戶arrow-up-right回應格式

更新

URL Parameters

PARAMETER

DESCRIPTION

id

客戶的 ID

Query Parameters

PARAMETER

REQUIRED

DEFAULT

TYPE

DESCRIPTION

membership_no

false

NULL

String

會員編號

identity_no

false

NULL

String

身分證

gender

false

NULL

Number

性別 0: 女 1: 男

first_name

false

NULL

String

last_name

false

NULL

String

birth_at

false

NULL

Date

出生日期

cz_cols

false

NULL

Array

自訂欄位,參數型態參考下方 CzCol 表格說明

tag_ids

false

NULL

Array

客戶標籤,傳入客戶標籤 ID

company_ids

false

NULL

Array

公司系統編號

Response

請參考客戶arrow-up-right回應格式

刪除

URL Parameters

PARAMETER

DESCRIPTION

id

客戶arrow-up-right的系統編號
 #ID

Last updated