Hyfin Logo
API Docs 3.0API Docs 3.1API Docs 4.0 SimpleAPI Docs 4.0

Get Item

The following endpoint can be used to retrieve the details of an item within the Hyfin application.

Endpoint

The following endpoint can be used to retrieve an item. You must replace the base_url , external_id and site_id variables with the appropriate values.

GET
{base_url}/api/v4/site/{site_id}/item/{external_id}
Request
No body is required for this API call
Response
Field
Type
Required
Description
_id
String
The id of the item. This field is auto generated by the system and is not required when creating a new item, but it is required when updating an existing item.
name
String
The name of the item.
description
String
The description of the item.
unit_price
Number
The price per unit of the item. Format = 0.00
active
Boolean
--
This flag represents whether the item record is active and available to be used or not.
Default = `true`
created_at
Date
--
The date the item was created.
updated_at
Date
--
The date the item was last updated.
Sample Response
			
				{
  "_id": "6839e415564d3cc2160d945e",
  "name": "Garlic Soy Tikkudak Wings",
  "description": "Tikkudak is a specialty where fried chicken is baked in a charcoal oven to create a smoky and crispy flavor.",
  "unit_price": "15.00",
  "created_at": "2025-05-30T19:19:44.143Z",
  "updated_at": "2025-05-30T19:19:44.143Z"
}