Get Contact

Use this when you need one contact as Hyfin has it, by its _id.


The following endpoint can be used to retrieve the details of a contact within the Hyfin application.


Endpoint

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}
Request
No body is required for this API call
Response
Field
Type
Description
_id
String
The id we assign to this contact. Leave it out when creating a contact, and send it when updating one.
externalId
String
Your own id for this contact, from your software. Send the same externalId again to update this contact instead of adding a new one. We match on this value but do not stop duplicates, so keep it unique within the site.
firstName
String
The first name of the contact.
lastName
String
The last name of the contact.
displayName
String
The name that will be displayed for the contact. If left blank, it will default to the first and last name.
language
String
The preferred language for the contact. Uses ISO 639-1 language codes.
Default = en
emails
A list of email addresses for the contact.
phoneNumbers
A list of phone numbers for the contact.
addresses
A list of addresses for the contact.
createdAt
The date the contact was created. A moment in time in ISO 8601, with a time zone. Format = YYYY-MM-DDTHH:mm:ss.SSSZ
updatedAt
The date the contact was last updated. A moment in time in ISO 8601, with a time zone. 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"
}


		

Related