Pular para o conteúdo principal
GET
Obtenha todos os profiles associados ao primary profile. O Primary Profile não é retornado nos resultados. Por segurança, os Profile Keys não são retornados por esta chamada GET. Consulte aqui para mais informações.

Parâmetros do cabeçalho

Parâmetros de consulta

title
string
Retorna somente o profile associado ao título codificado em URL.
refId
string
Retorna somente o profile associado ao refId informado. O refId foi retornado na criação do profile ou pelo endpoint /user.
hasActiveSocialAccounts
boolean
padrão:false
Se true, retorna somente profiles que tenham pelo menos uma conta social conectada (comprimento de activeSocialAccounts maior que zero). Se false, retorna somente profiles com zero contas sociais conectadas (comprimento de activeSocialAccounts igual a zero).
includesActiveSocialAccounts
array
Filtra os profiles para incluir aqueles cujo activeSocialAccounts contém todas as plataformas de mídia social especificadas na lista includesActiveSocialAccounts. Os profiles podem ter plataformas adicionais em seu activeSocialAccounts além das listadas em includesActiveSocialAccounts e, ainda assim, serem incluídos nos resultados filtrados.Valores: bluesky, facebook, gmb, instagram, linkedin, pinterest, reddit, snapchat, telegram, threads, tiktok, twitter, youtube.
isByokLinked
boolean
Filtra os profiles pelo status de migração BYOK (Bring Your Own Key). Se true, retorna somente profiles que concluíram a migração BYOK. Se false, retorna somente profiles que possuem uma plataforma elegível para BYOK conectada, mas que ainda não migraram. Profiles sem uma plataforma elegível para BYOK são excluídos quando esse filtro é definido. Quando omitido, todos os profiles são retornados independentemente do status BYOK. Atualmente aplica-se ao X/Twitter BYOK.
actionLog
boolean
padrão:false
Retorna o histórico do log de ações de criação e exclusão de User Profile dos últimos 60 dias e a contagem de usuários ativos usada para faturamento nos últimos 60 dias. Observação:
  • Action Log: título e tags não serão retornados no histórico de log de ações anterior a março de 2025.
  • Relatório de User Profiles: o período pode não corresponder ao seu período de faturamento. Por exemplo, seu período de faturamento pode começar e terminar no dia 10 do mês. Consulte suas faturas para o período de faturamento e outros detalhes.
Você pode especificar um período diferente definindo actionLog como um número de dias. Por exemplo, o parâmetro de consulta actionLog=10 retornará o log de ações dos últimos 10 dias e a contagem de usuários ativos reportada para os últimos 10 dias. O período permitido é de 1 dia a 365 dias.
limit
number
padrão:5000
Limita o número de profiles retornados. O padrão e o máximo é 5000.
cursor
string
Se houver profiles adicionais a retornar e a flag hasMore for true, o nextCursor será retornado na resposta. Passe esse cursor no parâmetro de consulta cursor para retornar o próximo conjunto de profiles.
include
string | array
Retorna dados estendidos do profile para diagnóstico. Requer o parâmetro refId (consulta de um único profile).Valores (string separada por vírgulas ou matriz): suspension, socialHealth, linkingErrors, activity, quota, unlinkHistory, actionLog.
  • suspension - isSuspended, reason, suspendedAt, unsuspendAt, suspensionCount
  • socialHealth - Por plataforma: linked, linkedAt, relinkRecommended, messagingEnabled, tokenExpiresAt
  • linkingErrors - Por plataforma: code, message, details, createdAt
  • activity - carimbos de data/hora lastApiCall, lastPost
  • quota - used, limit
  • unlinkHistory - Última desvinculação: platform, source (user/system), details, createdAt
  • actionLog - Histórico de ações do profile (create/update/delete)