Passer au contenu principal
GET
Récupérer un rapprochement 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 requête

id
string

Identifiant Mongo du match (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 du match. Exclusif avec id.

Réponse

Match trouvé (ou null si hors scope / inexistant).

success
boolean
match
object | null

Rapprochement (match) entre une vente et une acquisition.