Get Contact
The following endpoint can be used to retrieve the details of a contact within the Hyfin application.
Point de terminaison
The following endpoint can be used to retrieve a contact. You must replace the {base_url} , {site_id} and {_id} variables with the appropriate values.
GET
{base_url}/api/v4/site/{site_id}/contact/{_id}
Demande
Aucun corps n'est requis pour cet appel API
Réponse
Champ
Type
Requis
Description
_id
String
L'identifiant du contact. Ce champ est généré par le système et n'est pas requis lors de la création d'un nouveau contact, mais il est requis lors de la mise à jour d'un contact existant.
first_name
String
--
Le prénom du contact.
last_name
String
--
Le nom de famille du contact.
display_name
String
--
Le nom qui sera affiché pour le contact. S'il est laissé vide, il sera par défaut le prénom et le nom de famille.
language
String
--
La langue préférée pour le contact. Utilise les codes de langue ISO 639-1.
Default = `en`
Default = `en`
emails
--
Une liste d'adresses courriel pour le contact.
phone_numbers
--
Une liste de numéros de téléphone pour le contact.
addresses
--
Une liste d'adresses pour le contact.
created_at
Date
--
La date à laquelle le contact a été créé.
updated_at
Date
--
La date de la dernière mise à jour du contact.
Sample Response
{
"first_name": "John",
"last_name": "Doe",
"display_name": "John Doe",
"language": "en",
"emails": [
{
"label": "work",
"address": "johndoe@abc.com",
"is_primary": true
}
],
"phone_numbers": [
{
"label": "mobile",
"number": "333-444-5555",
"is_primary": true
}
],
"addresses": [
{
"label": "billing",
"is_primary": true,
"address": {
"address_line1": "123 Main Street",
"address_line2": "Suite 123",
"city": "Naples",
"state_code": "FL",
"zip_code": "34102"
}
}
],
"created_at": "2025-05-30T19:19:44.143Z",
"updated_at": "2025-05-30T19:19:44.143Z",
"_id": "6839e415564d3cc2160d945e"
}