跳转到主要内容
GET
获取与 Primary Profile 关联的所有 profile。结果中不会包含 Primary Profile 本身。 出于安全考虑,此 GET 调用不会返回 Profile Key。更多信息请参阅此处

Header 参数

Query 参数

title
string
仅返回与经 URL 编码的 title 关联的 profile。
refId
string
仅返回与给定 refId 关联的 profile。refId 在创建 profile 时或从 /user 端点返回。
hasActiveSocialAccounts
boolean
默认值:false
若为 true,仅返回至少已连接一个社交账户的 profile(activeSocialAccounts 长度大于零)。若为 false,仅返回未连接任何社交账户的 profile(activeSocialAccounts 长度为零)。
includesActiveSocialAccounts
array
筛选 profile,仅包含其 activeSocialAccounts 包含 includesActiveSocialAccounts 列表中所有社交媒体平台的 profile。profile 的 activeSocialAccounts 中可以包含 includesActiveSocialAccounts 之外的其他平台,依然会被包含在过滤结果中。可选值:blueskyfacebookgmbinstagramlinkedinpinterestredditsnapchattelegramthreadstiktoktwitteryoutube
isByokLinked
boolean
按 BYOK(Bring Your Own Key)迁移状态筛选 profile。若为 true,仅返回已完成 BYOK 迁移的 profile。若为 false,仅返回连接了符合 BYOK 条件的平台但尚未完成迁移的 profile。设置该过滤器时,未连接任何符合 BYOK 条件平台的 profile 将被排除。若省略此参数,则返回所有 profile,不考虑 BYOK 状态。目前适用于 X/Twitter BYOK
actionLog
boolean
默认值:false
返回过去 60 天内 User Profile 的创建与删除操作日志历史,以及过去 60 天内用于计费的活跃用户数量。注意:
  • 操作日志:2025 年 3 月之前的操作日志历史中不会返回 title 和 tag。
  • User Profile 报告:该时间段可能与你的计费周期不一致。例如,你的计费周期可能是每月 10 号开始至下月 10 号结束。 请查看你的发票以获取计费周期和其他详情。
你也可以将 actionLog 设置为一个天数以指定不同的时间段。例如,actionLog=10 查询参数将返回过去 10 天的操作日志和过去 10 天报告的活跃用户数量。允许的时间范围为 1 到 365 天。
limit
number
默认值:5000
限制返回的 profile 数量。默认值和最大值均为 5000。
cursor
string
若还有更多 profile 可返回且 hasMore 标志为 true,响应中将返回 nextCursor。 将该 cursor 传入 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)