Get Customer

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

Endpoint

The following endpoint can be used to retrieve a customer. You must replace the {base_url} , {site_id} and {external_id} variables with the appropriate values.

GET

{base_url}/api/v3.1/site/{site_id}/customer/{external_id}

Request

No body is required for this API call

Response

Field

Type

Description

external_id

String

The unique customer id from the source system/database. If we detect a record with the same external_id, it will be updated, otherwise it will be added.

_id

String

The auto generated id assigned to the customer by the system.

first_name

String

The first name of the customer. At least one of first_name, last_name, account_name, email, or mobile_phone is required.

last_name

String

The last name of the customer. At least one of first_name, last_name, account_name, email, or mobile_phone is required.

account_name

String

If the customer is a business, you may use this field as an extra identifier (Ex. 123 Main Street or ABC Company). At least one of first_name, last_name, account_name, email, or mobile_phone is required.

mobile_phone

String

The customers mobile phone number. Required if notification_options.notify_phone is enabled. At least one of first_name, last_name, account_name, email, or mobile_phone is required.

String

The customers email address. Required if notification_options.notify_email is enabled. At least one of first_name, last_name, account_name, email, or mobile_phone is required.

notes

String

Internal customer notes. Visible to merchant only.

display_name

String

The customer's name as it is shown to them, built by the system from the name fields above.

reference_number

String

A short human readable id the system assigns to the customer.

contacts

The contacts attached to the customer. A customer created through the API always has one, built from the name, email and phone above.

notification_options

The customer's preferences for receiving notifications via text message and email.

created_at

Date

The date the customer was created.

updated_at

Date

The date the customer was last updated.

Sample Response

			
{
  "_id": "6839e415564d3cc2160d945e",
  "external_id": "39772634",
  "reference_number": "N7E6NCFYECH9",
  "first_name": "John",
  "last_name": "Doe",
  "account_name": null,
  "display_name": "John Doe",
  "mobile_phone": "12223334444",
  "email": "johndoe@abc.com",
  "notes": "World's best customer",
  "notification_options": {
    "notify_phone": true,
    "notify_email": false,
    "notify_whats_app": false
  },
  "contacts": [
    {
      "_id": "61f32dc2f62bdc6a48951255",
      "is_primary": true,
      "roles": []
    }
  ],
  "created_at": "2025-05-30T19:19:44.143Z",
  "updated_at": "2025-05-30T19:19:44.143Z"
}