Get Customer
The following endpoint can be used to retrieve the details of a customer within the Hyfin application.
Point de terminaison
The following endpoint can be used to retrieve a customer. You must replace the {base_url} , {site_id} and {external_id} variables with the appropriate values.
GET
{base_url}/api/v3.1/site/{site_id}/customer/{external_id}
Demande
Aucun corps n'est requis pour cet appel API
Réponse
Champ
Type
Requis
Description
external_id
String
The unique customer id from the source system/database. If we detect a record with the same `external_id`, it will be updated, otherwise it will be added.
first_name
String
Le prénom du client.
last_name
String
Le nom de famille du client.
account_name
String
--
Si le client est une entreprise, vous pouvez utiliser ce champ comme identifiant supplémentaire (Ex. 123 rue Principale ou Entreprise ABC).
mobile_phone
String
--
The customers mobile phone number. Required if `notification_options.notify_phone` is enabled.
email
String
--
The customers email address. Required if `notification_options.notify_email` is enabled.
notes
String
--
Notes internes pour le client. Visible seulement par le commerçant.
active
Boolean
--
Que le dossier du client soit actif et disponible pour être utilisé.
Default = `true`
Default = `true`
notification_options
--
Les préférences du client pour recevoir des notifications par message texte et courriel.
created_at
Date
--
La date à laquelle le client a été créé.
updated_at
Date
--
La date à laquelle le client a été mis à jour pour la dernière fois.
Sample Response
{
"_id": "6839e415564d3cc2160d945e",
"external_id": "39772634",
"first_name": "John",
"last_name": "Doe",
"account_name": null,
"mobile_phone": "12223334444",
"email": "johndoe@abc.com",
"notification_options": {
"notify_phone": true,
"notify_email": false
},
"created_at": "2025-05-30T19:19:44.143Z",
"updated_at": "2025-05-30T19:19:44.143Z"
}