Skip to navigation

查詢客戶帳號清單

View as Markdown

分頁查詢某一家客戶底下的帳號,依 id 由小到大排序。

可用下列參數篩選:

  • account、name、email:大小寫不敏感的子字串比對
  • status:Active 或 Inactive,完全比對,但大小寫不敏感

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

客戶不存在或屬於其他租戶時回傳 404 company_not_found,而不是空的清單——這樣才分得出「這家客戶還沒有帳號」與「客戶序號帶錯」。

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 排查步驟,請參閱「驗證與簽章」。

Path parameters

idlongRequired

客戶序號,對應客戶主檔的 id。查無此客戶或屬於其他租戶時,一律回傳 404 company_not_found。

Query parameters

accountstringOptional

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

namestringOptional

依姓名篩選。規則與 account 相同。

emailstringOptional

依電子郵件篩選。規則與 account 相同。

statusstringOptional

依帳號狀態篩選,Active 或 Inactive。完全比對,但大小寫不敏感,前後空白也會被忽略。帶其他值不會回傳錯誤,只會查不到任何帳號。

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
404
Not Found Error
500
Internal Server Error