Перейти до основного вмісту
GET
Отримайте всі профілі, пов’язані з primary profile. Primary Profile не повертається у результатах. З міркувань безпеки Profile Keys не повертаються через цей GET-виклик. Див. тут для отримання додаткової інформації.

Header Parameters

Query Parameters

title
string
Повернути лише профіль, пов’язаний з URL-кодованою назвою.
refId
string
Повернути лише профіль, пов’язаний з наданим refId. refId було повернуто під час створення профілю або з ендпоінта /user.
hasActiveSocialAccounts
boolean
за замовчуванням:false
Якщо true, повертати лише профілі, які мають принаймні один підключений соціальний обліковий запис (довжина activeSocialAccounts більше нуля). Якщо false, повертати лише профілі з нульовою кількістю підключених соціальних облікових записів (довжина activeSocialAccounts дорівнює нулю).
includesActiveSocialAccounts
array
Фільтрувати профілі, включаючи ті, чиї activeSocialAccounts містять усі соціальні мережі, вказані у списку includesActiveSocialAccounts. Профілі можуть мати додаткові платформи у своїх activeSocialAccounts окрім вказаних у includesActiveSocialAccounts і все одно бути включеними у відфільтровані результати.Значення: bluesky, facebook, gmb, instagram, linkedin, pinterest, reddit, snapchat, telegram, threads, tiktok, twitter, youtube.
isByokLinked
boolean
Фільтрувати профілі за статусом міграції BYOK (Bring Your Own Key). Якщо true, повертати лише профілі, які завершили міграцію BYOK. Якщо false, повертати лише профілі, які мають підключену BYOK-сумісну платформу, але ще не мігрували. Профілі без BYOK-сумісної платформи виключаються, коли встановлено цей фільтр. Якщо опущено, повертаються всі профілі незалежно від статусу BYOK. Наразі застосовується до X/Twitter BYOK.
actionLog
boolean
за замовчуванням:false
Повернути історію action log створення та видалення User Profile за останні 60 днів і кількість активних користувачів, що використовується для розрахунків, за останні 60 днів. Примітка:
  • Action Log: Назва й теги не повертаються для історії action log до березня 2025 року.
  • User Profile Report: Часовий період може не відповідати вашому періоду виставлення рахунків. Наприклад, ваш період виставлення рахунків може починатися й закінчуватися 10-го числа місяця. Див. свої рахунки для періоду виставлення й інших деталей.
Ви можете вказати інший часовий період, встановивши actionLog у кількість днів. Наприклад, query-параметр actionLog=10 поверне action log за останні 10 днів і повідомлену кількість активних користувачів за останні 10 днів. Дозволений часовий період — від 1 до 365 днів.
limit
number
за замовчуванням:5000
Обмежити кількість повернутих профілів. За замовчуванням і максимально — 5000.
cursor
string
Якщо є додаткові профілі для повернення, а прапорець hasMore true, у відповіді буде повернено nextCursor. Передайте цей курсор у query-параметр cursor, щоб повернути наступний набір профілів.
include
string | array
Повернути розширені дані профілю для усунення несправностей. Потребує параметра refId (пошук окремого профілю).Значення (рядок, розділений комами, або масив): suspension, socialHealth, linkingErrors, activity, quota, unlinkHistory, actionLog.
  • suspension - isSuspended, reason, suspendedAt, unsuspendAt, suspensionCount
  • socialHealth - Per-platform: linked, linkedAt, relinkRecommended, messagingEnabled, tokenExpiresAt
  • linkingErrors - Per-platform: code, message, details, createdAt
  • activity - lastApiCall, lastPost timestamps
  • quota - used, limit
  • unlinkHistory - Last unlink: platform, source (user/system), details, createdAt
  • actionLog - Profile action history (create/update/delete)