Skip to navigation

查詢客戶總部清單

View as Markdown

⚠️ 群組決定資料可見範圍:總部客戶的 Boss 角色使用者看得到群組內所有成員的資料。這支端點只讀取,不會改變可見範圍。

分頁查詢客戶總部清單,依群組序號由小到大排列,每一列的形狀與「查詢單一客戶總部」相同。可用 name 篩選群組名稱,大小寫不敏感的子字串比對,前後空白會被忽略。沒有 updatedSince 篩選。

page 從 1 起算,pageSize 為 1–100(預設 100),超出範圍一律回 400。

Authentication

X-Signaturestring

每個 /v1 請求都必須帶 X-Client-Id、X-Timestamp、X-Nonce 與 X-Signature 四個標頭。X-Signature 是以 client secret 對 canonical string 做 HMAC-SHA256 後的 Base64。

canonical string 的組成、可複製的簽章範例與 401 排查步驟,請參閱「驗證與簽章」。

Query parameters

namestringOptional

依群組名稱篩選。大小寫不敏感的子字串比對,前後空白會被忽略。

pageintegerOptional

頁碼,從 1 起算,省略時預設 1。小於 1 回傳 400 invalid_page;頁碼大到讓內部位移量溢位時同樣回傳 400 invalid_page。

pageSizeintegerOptional

每頁筆數,範圍 1 至 100,省略時預設 100。超出範圍一律回傳 400 invalid_page_size,不會自動夾限成合法值,避免分批掃描時誤判為已經抓完全部資料。

Response

OK
datalist of objects or nullOptional

本頁的客戶總部資料,每一筆為一筆客戶總部資料,形狀與「查詢單一客戶總部」的回應相同。

totalCountintegerOptional

符合篩選條件的客戶總部總數,涵蓋所有頁,不受目前頁碼影響。

currentPageintegerOptional

目前頁碼,即請求帶入的 page,從 1 起算。

pageSizeintegerOptional

目前頁面的筆數上限,即請求帶入的 pageSize。

totalPagesintegerOptional

總頁數,等於 totalCount 除以 pageSize 後無條件進位;沒有符合的資料時為 0。

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
500
Internal Server Error