Passer au contenu principal
GET
Récupérer une transaction par id ou customId

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

id
string

Identifiant Mongo de la transaction (24 chars hex). Exclusif avec customId. Identifiant Mongo (24 caractères hexadécimaux).

Pattern: ^[a-fA-F0-9]{24}$
Exemple:

"618a35a36d932054e195ca0a"

customId
string

Identifiant métier (ex: EBZJ7515), sensible à la casse. Exclusif avec id.

Réponse

Transaction trouvée (ou null si hors scope / inexistante). La clé sale / acquisition / rental dépend du type demandé.

La clé de la transaction (sale / acquisition / rental) dépend du type demandé ; elle vaut null si non trouvée ou hors scope.

success
boolean
sale
object | null

Vente en lecture. id, customId, agency, agencyGroup, step, createdAt, updatedAt, stepUpdatedAt, owner et mainContact sont toujours présents (si la vente existe). Les autres champs sont absents s'ils ne sont pas renseignés.

acquisition
object | null

Acquisition en lecture. id, customId, agency, agencyGroup, step, createdAt, updatedAt, stepUpdatedAt, owner et mainContact sont toujours présents (si l'acquisition existe). Les autres champs sont absents s'ils ne sont pas renseignés.

rental
object | null

Location en lecture. id, customId, agency, agencyGroup, step, createdAt, updatedAt, stepUpdatedAt, owner et mainContact sont toujours présents (si la location existe). Les autres champs sont absents s'ils ne sont pas renseignés.

contacts
object[]