Passer au contenu principal
GET
Rechercher des transactions (paginé)

Autorisations

Authorization
string
header
requis

Token LinkedAPI avec scope externalIntegration. La clé doit avoir un agencyGroup configuré (sinon 400 LinkedAPI agencyGroup is required). Fourni via l'en-tête Authorization: Bearer {linkedAPI_token}. Si la clé a secure === true, l'IP appelante doit être whitelistée (en-tête X-Real-IP), sinon 403 Not authorized to access this resource.

La clé porte aussi un niveau d'accès : en lecture seule, elle n'autorise que les GET ; un POST ou un PATCH renvoie alors 403 Not authorized to access this resource, soit la même réponse qu'une requête sans en-tête Authorization. Voir le guide Authentification.

Paramètres de chemin

transaction
enum<string>
requis

Type de transaction.

Options disponibles:
acquisition,
sale,
rental

Paramètres de requête

Texte libre. Minimum 3 caractères. Recherche sur nom / téléphone / email / adresse / customId. Les mots vides FR (de, la, le...) ne sont pas pris en compte.

Minimum string length: 3
page
integer
défaut:1

Page 1-indexée. Défaut 1. Max 100.

Plage requise: 1 <= x <= 100
sortField
enum<string>
défaut:createdAt

Champ de tri. Défaut createdAt.

Options disponibles:
createdAt,
updatedAt,
stepUpdatedAt
sortOrder
enum<string>
défaut:desc

Ordre de tri. Défaut desc. S'envoie avec sortField : seul, il est refusé (400).

Options disponibles:
asc,
desc
step
string[]

Filtre sur l'étape. Valeurs autorisées selon le type : sale (STK, TRN, ARC, PQUL, QUL, CNV, RDV, DLV, MND, TARC, OFR, AGT, MTG, SLD) ; acquisition (AQUL, ASRC, ANGT, AOFR, ACLS, AARC) ; rental (RQUL, RCNV, RRDV, RDLV, RMDT, RARC, RMAR, RRTD, RRTM). Répétable → logique « OU ».

owner
string[]

Filtre sur l'utilisateur Avest responsable du dossier (ObjectId). Répétable → logique « OU ».

tags
string[]

Filtre sur un tag de la fiche (ObjectId). acquisition et rental uniquement (non supporté sur sale → 400). Répétable → logique « OU ».

Réponse

Liste paginée de transactions. La clé sales / acquisitions / rentals dépend du type demandé.

La clé contenant les résultats (sales / acquisitions / rentals) dépend du type demandé.

success
boolean
sales
object[]
acquisitions
object[]
rentals
object[]
page
integer
limit
integer

Taille de page (fixe, non paramétrable). ⚠️ Ce champ s'appelle limit ici, mais pageSize sur /activities et /ad/search — deux noms pour la même chose, historique et conservé pour ne pas casser les intégrations existantes.

hasMore
boolean