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

Required

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.

first_name

String

The first name of the contact.

last_name

String

The last name of the contact.

display_name

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.

phone_numbers

A list of phone numbers for the contact.

addresses

A list of addresses for the contact.

created_at

Date

The date the contact was created.

updated_at

Date

The date the contact was last updated.

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"
}