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 {_id} variables with the appropriate values.

GET

{base_url}/api/v4/site/{site_id}/customer/{_id}

Request

No body is required for this API call

Response

Field

Type

Required

Description

_id

String

The id of the customer. This field is auto generated by the system and is not required when creating a new customer, but it is required when updating an existing customer.

display_name

String

The name that will be displayed for the customer.

account_name

String

If the customer is a group, you may want to provide a business name or the customer's address here.

contacts

A list of customer contacts. Required if `primary_contact` is not passed in.

parent_customer

String

The id of the parent customer, if applicable.

bill_to_parent_flag

Boolean

A flag indicating whether the parent customer should be billed for this customer. Only applicable if `parent_customer` is provided.

notes

String

Internal customer notes. Visible to merchant only.

attachment_refs

A list of attachments.

deleted

Boolean

Whether the customer record has been deleted and is no longer active.
Default = `false`

created_at

Date

The date the customer was created.

updated_at

Date

The date the customer was last updated.

Sample Response

			
				{
  "_id": "6839e415564d3cc2160d945e",
  "display_name": "ABC Plumbing",
  "created_at": "2025-05-30T19:19:44.143Z",
  "updated_at": "2025-05-30T19:19:44.143Z",
  "contacts": [
    {
      "_id": "6839e415564d3cc21603236y",
      "first_name": "John",
      "last_name": "Doe",
      "display_name": "John Doe",
      "language": "en",
      "emails": [
        {
          "label": "work",
          "address": "johndoe@abc.com"
        }
      ],
      "phoneNumbers": [
        {
          "label": "mobile",
          "number": "333-444-5555"
        }
      ],
      "addresses": [
        {
          "label": "billing",
          "address": {
            "address_line1": "123 Main Street",
            "address_line2": "Suite 123",
            "city": "Naples",
            "state_code": "FL",
            "zip_code": "34102"
          }
        },
        {
          "label": "shipping",
          "address": {
            "address_line1": "456 Boulevard Street",
            "city": "Naples",
            "state_code": "FL",
            "zip_code": "34102"
          }
        }
      ]
    }
  ]
}