Passer au contenu principal
Liste paginée des activités (notes, rendez-vous, emails, tâches, …) rattachées à un document : annonce, vente, acquisition, location, match ou contact.

Endpoint

URL : /external-integration/activities Méthode : GET Authentification : Requiert un token LinkedAPI avec scope externalIntegration et une clé rattachée à un groupe d’agences. Clé requise : toutes les clés (lecture seule suffit). Voir Types de clé.

Headers

Query Parameters

document et documentType sont obligatoires.

Pagination et tri

  • Taille de page fixe : 20 activités.
  • Itérez jusqu’à hasMore: false.
  • Tri : createdAt décroissant (activité saisie le plus récemment en premier).
  • Le champ de taille de page de la réponse s’appelle ici pageSize — mais limit sur GET Contacts, GET Users et GET Transaction Search. Même sens, deux noms : lisez celui de la route que vous appelez.
Le tri porte sur createdAt, pas sur la date métier de l’activité (par exemple data.visitStartAt pour une visite). Une visite saisie aujourd’hui pour une date passée remontera avant une visite saisie hier pour demain. Pour obtenir « la dernière visite », triez côté client sur le champ de date métier — ne prenez pas le premier élément de la liste.

Exemples de requête

Réponse de succès

Code : 200

Aucun résultat

Champs de la réponse

Chaque élément de activities :
Aucun thumbnail n’est exposé. La pièce jointe file.url est un lien S3 signé temporaire vers un objet privé — à télécharger côté serveur, ne pas mettre en cache durablement.

Types d’activité

Le champ type est toujours en minuscules. Les types ci-dessous sont ceux que vous rencontrerez le plus souvent en lecture ; la liste n’est pas fermée et de nouveaux types peuvent apparaître.
Traitez type comme un ensemble ouvert : ignorez silencieusement les valeurs que vous ne connaissez pas plutôt que de rejeter la réponse.
Les visites et les offres sont des activités rattachées au match. Leur lecture, le schéma de leur data et leurs limites font l’objet d’une page dédiée : Visites & offres.

Écriture : ce qui n’est pas possible

POST /external-integration/activity est plus restreint que la lecture :
  • types acceptés : note, task, call, message, email, meeting, appointment uniquement ;
  • documentType accepté : acquisition, sale, rental, contact uniquement.
Il n’est donc pas possible de créer ni de modifier une visite ou une offre via l’API externe, ni de rattacher une activité à un match. Ces objets sont aujourd’hui accessibles en lecture seule.

Réponses d’erreur

  • document manquant : 400 Bad Request
  • documentType manquant ou invalide : 400 Bad Request
  • LinkedAPI agencyGroup manquant : 400 Bad Request
  • Header Authorization absent, ou IP non whitelistée sur une clé sécurisée : 403 Not authorized to access this resource
  • Token invalide : 401 Invalid bearer token

Notes

  1. Scope : seules les activités rattachées à un document de votre périmètre autorisé sont retournées.
  2. Pagination : 20 activités par page. Itérez jusqu’à hasMore: false.
  3. Pièces jointes : file.url est un lien S3 signé temporaire vers un fichier privé. Pas de thumbnail. Testez file et file.url avant de télécharger : un document signé électroniquement, par exemple, peut remonter sans lien de téléchargement.
  4. Endpoint en lecture seule.

Rate limits

Cette route est limitée à 200 req / minute par groupe d’agences (bucket dédié).
  • Headers : RateLimit-Limit, RateLimit-Remaining, RateLimit-Reset (secondes avant reset).
  • Dépassement → 429 Too Many Requests avec header Retry-After :