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

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.

displayName

String

The name that will be displayed for the customer.

accountName

String

A business name or address for the customer, useful when the customer is a group. Required if more than one entry is provided in contacts.

contacts

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

parentCustomer

String

The id of the parent customer, if applicable.

billToParentFlag

Boolean

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

notes

String

Internal customer notes. Visible to merchant only.

attachmentRefs

A list of attachments.

createdAt

Date

The date the customer was created.

updatedAt

Date

The date the customer was last updated.

deleted

Boolean

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

Sample Response

			
{
  "_id": "6839e415564d3cc2160d945e",
  "displayName": "ABC Plumbing",
  "accountName": null,
  "contacts": [
    {
      "_id": "6839e415564d3cc216032361",
      "isPrimary": true,
      "roles": []
    }
  ],
  "billToParentFlag": false,
  "notes": null,
  "attachmentRefs": {
    "internal": [],
    "external": []
  },
  "deleted": false,
  "createdAt": "2025-05-30T19:19:44.143Z",
  "updatedAt": "2025-05-30T19:19:44.143Z"
}