Passer au contenu principal
GET
Obtenez tous les profils associés au profil principal. Le profil principal n’est pas retourné dans les résultats. Pour des raisons de sécurité, les clés de profil ne sont pas retournées via cet appel GET. Veuillez consulter ici pour plus d’informations.

Paramètres d’en-tête

Paramètres de requête

title
string
Retourne uniquement le profil associé au titre encodé en URL.
refId
string
Retourne uniquement le profil associé au refId donné. Le refId a été retourné lors de la création du profil ou depuis le point de terminaison /user.
hasActiveSocialAccounts
boolean
défaut:false
Si true, retourne uniquement les profils qui ont au moins un compte social connecté (longueur de activeSocialAccounts supérieure à zéro). Si false, retourne uniquement les profils avec zéro compte social connecté (longueur de activeSocialAccounts égale à zéro).
includesActiveSocialAccounts
array
Filtrez les profils pour inclure ceux dont activeSocialAccounts contient toutes les plateformes de réseaux sociaux spécifiées dans la liste includesActiveSocialAccounts. Les profils peuvent avoir des plateformes supplémentaires dans leur activeSocialAccounts en plus de celles listées dans includesActiveSocialAccounts tout en étant inclus dans les résultats filtrés.Valeurs : bluesky, facebook, gmb, instagram, linkedin, pinterest, reddit, snapchat, telegram, threads, tiktok, twitter, youtube.
isByokLinked
boolean
Filtrez les profils selon le statut de migration BYOK (Bring Your Own Key). Si true, retourne uniquement les profils qui ont terminé la migration BYOK. Si false, retourne uniquement les profils qui ont une plateforme éligible BYOK connectée mais qui n’ont pas encore migré. Les profils sans plateforme éligible BYOK sont exclus lorsque ce filtre est défini. Lorsqu’il est omis, tous les profils sont retournés indépendamment du statut BYOK. S’applique actuellement à X/Twitter BYOK.
actionLog
boolean
défaut:false
Retourne l’historique du journal d’actions de création et de suppression des profils d’utilisateur pour les 60 derniers jours ainsi que le nombre d’utilisateurs actifs utilisé pour la facturation pour les 60 derniers jours. Remarque :
  • Journal d’actions : le titre et les étiquettes ne seront pas retournés pour l’historique du journal d’actions antérieur à mars 2025.
  • Rapport de profils d’utilisateur : la période peut ne pas correspondre à votre période de facturation. Par exemple, votre période de facturation peut commencer et se terminer le 10 du mois. Consultez vos factures pour la période de facturation et d’autres détails.
Vous pouvez spécifier une période différente en définissant actionLog sur un nombre de jours. Par exemple, le paramètre de requête actionLog=10 retournera le journal d’actions pour les 10 derniers jours et le nombre d’utilisateurs actifs signalé pour les 10 derniers jours. La période autorisée est de 1 jour à 365 jours.
limit
number
défaut:5000
Limite le nombre de profils retournés. La valeur par défaut et maximale est de 5000.
cursor
string
S’il y a des profils supplémentaires à retourner et que l’indicateur hasMore est true, le nextCursor sera retourné dans la réponse. Passez ce curseur au paramètre de requête cursor pour retourner l’ensemble suivant de profils.
include
string | array
Retourne des données de profil étendues pour le dépannage. Nécessite le paramètre refId (recherche d’un seul profil).Valeurs (chaîne séparée par des virgules ou tableau) : suspension, socialHealth, linkingErrors, activity, quota, unlinkHistory, actionLog.
  • suspension - isSuspended, reason, suspendedAt, unsuspendAt, suspensionCount
  • socialHealth - Par plateforme : linked, linkedAt, relinkRecommended, messagingEnabled, tokenExpiresAt
  • linkingErrors - Par plateforme : code, message, details, createdAt
  • activity - horodatages lastApiCall, lastPost
  • quota - used, limit
  • unlinkHistory - Dernier délien : platform, source (user/system), details, createdAt
  • actionLog - Historique des actions de profil (create/update/delete)