Get Contact
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 of the contact. This field is auto generated by the system and is not required when creating a new contact, but it is required when updating an existing contact.
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
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
Date
The date the contact was created.
updatedAt
Date
The date the contact was last updated.
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"
}