Get Contact

Usa esto cuando necesites un contacto tal como lo tiene Hyfin, mediante su _id.


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 que asignamos a este contacto. Omítelo al crear un contacto y envíalo al actualizar uno.
externalId
String
Tu propio id para este contacto, desde tu software. Envía de nuevo el mismo externalId para actualizar este contacto en lugar de agregar uno nuevo. Usamos este valor para hacer la coincidencia, pero no evitamos duplicados, así que manténgalo único dentro del sitio.
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
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
La fecha en que se creó el contacto. Un momento en el tiempo en formato ISO 8601, con zona horaria. Format = YYYY-MM-DDTHH:mm:ss.SSSZ
updatedAt
La fecha en que se actualizó por última vez el contacto. Un momento en el tiempo en formato ISO 8601, con zona horaria. Format = YYYY-MM-DDTHH:mm:ss.SSSZ
Sample Response
			
{
  "firstName": "John",
  "lastName": "Doe",
  "displayName": "John Doe",
  "language": "en",
  "emails": [
    {
      "label": "work",
      "address": "johndoe@abc.com",
      "isPrimary": true
    }
  ],
  "phoneNumbers": [
    {
      "label": "mobile",
      "number": "333-444-5555",
      "isPrimary": true
    }
  ],
  "addresses": [
    {
      "label": "billing",
      "isPrimary": true,
      "address": {
        "addressLine1": "123 Main Street",
        "addressLine2": "Suite 123",
        "city": "Naples",
        "stateCode": "FL",
        "zipCode": "34102"
      }
    }
  ],
  "createdAt": "2025-05-30T19:19:44.143Z",
  "updatedAt": "2025-05-30T19:19:44.143Z",
  "_id": "6839e415564d3cc2160d945e",
  "externalId": "58810342"
}


		

Ver también