跳转到主要内容
GET
取得與 Primary Profile 關聯的所有 Profile。結果中不會回傳 Primary Profile 本身。 基於安全考量,此 GET 呼叫不會回傳 Profile Key。更多資訊請參閱這裡

標頭參數

Query 參數

title
string
僅回傳與經 URL 編碼的 title 關聯的 Profile。
refId
string
僅回傳與指定 refId 關聯的 Profile。refId 是在建立 Profile 時或從 /user 端點回傳的。
hasActiveSocialAccounts
boolean
默认值:false
若為 true,僅回傳至少已連結一個社群帳號的 Profile(activeSocialAccounts 長度大於零)。若為 false,僅回傳零個已連結社群帳號的 Profile(activeSocialAccounts 長度為零)。
includesActiveSocialAccounts
array
篩選 activeSocialAccounts 中包含 includesActiveSocialAccounts 清單中所有社群平台的 Profile。Profile 的 activeSocialAccounts 可以擁有 includesActiveSocialAccounts 以外的其他平台,且仍會被納入篩選結果中。值:blueskyfacebookgmbinstagramlinkedinpinterestredditsnapchattelegramthreadstiktoktwitteryoutube
isByokLinked
boolean
依 BYOK(Bring Your Own Key)遷移狀態篩選 Profile。若為 true,僅回傳已完成 BYOK 遷移的 Profile。若為 false,僅回傳已連結符合 BYOK 資格平台但尚未完成遷移的 Profile。當設定此篩選條件時,未連結任何符合 BYOK 資格平台的 Profile 會被排除。若省略此參數,則不論 BYOK 狀態皆會回傳所有 Profile。目前適用於 X/Twitter BYOK
actionLog
boolean
默认值:false
回傳過去 60 天的 User Profile 建立與刪除操作記錄,以及過去 60 天用於計費的活躍使用者數。注意:
  • Action Log:2025 年 3 月之前的操作記錄不會回傳 title 與 tags。
  • User Profile Report:時間範圍不一定與你的計費週期對應。例如你的計費週期可能從每月 10 號開始並在每月 10 號結束。 計費週期與其他詳情請參閱你的發票。
你可以將 actionLog 設為天數以指定不同的時間範圍。例如, actionLog=10 查詢參數會回傳過去 10 天的操作記錄與過去 10 天的活躍使用者數。時間範圍允許為 1 天至 365 天。
limit
number
默认值:5000
限制回傳的 Profile 數量。預設值與最大值皆為 5000。
cursor
string
若尚有其他 Profile 可回傳(hasMore 旗標為 true),回應中會回傳 nextCursor。 將此游標傳入 cursor 查詢參數即可取得下一批 Profile。
include
string | array
回傳延伸的 Profile 資料以協助疑難排解。需要 refId 參數(單一 Profile 查詢)。值(以逗號分隔的字串或陣列):suspensionsocialHealthlinkingErrorsactivityquotaunlinkHistoryactionLog
  • suspension - isSuspended、reason、suspendedAt、unsuspendAt、suspensionCount
  • socialHealth - 各平台:linked、linkedAt、relinkRecommended、messagingEnabled、tokenExpiresAt
  • linkingErrors - 各平台:code、message、details、createdAt
  • activity - lastApiCall、lastPost 時間戳
  • quota - used、limit
  • unlinkHistory - 最近一次解除連結:platform、source(user/system)、details、createdAt
  • actionLog - Profile 操作記錄(create/update/delete)