Get Contact
The following endpoint can be used to retrieve the details of a contact within the Hyfin application.
Punto Final
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}
Solicitud
Ningún cuerpo es necesario para esta llamada de API
Respuesta
Campo
Tipo
Descripción
id
String
El id del contacto. Este campo es generado por el sistema y no es necesario al crear un nuevo contacto, pero es necesario al actualizar un contacto existente.
firstName
String
El primer nombre del contacto.
lastName
String
El apellido del contacto.
displayName
String
El nombre que se mostrará para el contacto. Si se deja en blanco, se establecerá por defecto el nombre y apellido.
language
String
El idioma preferido para el contacto. Utiliza códigos de idioma ISO 639-1.
Default = `en`
Default = `en`
emails
Una lista de direcciones de correo electrónico para el contacto.
phoneNumbers
Una lista de números de teléfono para el contacto.
addresses
Una lista de direcciones para el contacto.
createdAt
Date
La fecha en que se creó el contacto.
updatedAt
Date
La fecha en que se actualizó por última vez el contacto.
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"
}