Get Contact

Utilisez ceci lorsque vous avez besoin d'un contact tel que Hyfin le possède, à partir de son _id.


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
Description
_id
String
L'identifiant que nous attribuons à ce contact. Omettez-le lors de la création d'un contact et envoyez-le lors de la mise à jour d'un contact.
externalId
String
Votre propre identifiant pour ce contact, provenant de votre logiciel. Envoyez à nouveau le même externalId pour mettre à jour ce contact au lieu d'en ajouter un nouveau. Nous faisons la correspondance sur cette valeur, mais nous n'empêchons pas les doublons; gardez-la donc unique au sein du site.
firstName
String
Le prénom du contact.
lastName
String
Le nom de famille du contact.
displayName
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
emails
Une liste d'adresses courriel pour le contact.
phoneNumbers
Une liste de numéros de téléphone pour le contact.
addresses
Une liste d'adresses pour le contact.
createdAt
La date à laquelle le contact a été créé. Un moment précis en format ISO 8601, avec un fuseau horaire. Format = YYYY-MM-DDTHH:mm:ss.SSSZ
updatedAt
La date de la dernière mise à jour du contact. Un moment précis en format ISO 8601, avec un fuseau horaire. 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"
}


		

Voir aussi