Skip to main content
GET
/
equipment
/
{id}
Get equipment
curl --request GET \
  --url http:localhost:3000/v2/equipment/{id} \
  --header 'x-API-Key: <api-key>'
{
  "_id": "<string>",
  "number": 123,
  "companyId": "<string>",
  "status": {
    "status": 123,
    "createdAt": "2023-11-07T05:31:56Z",
    "createdBy": "<string>",
    "lastModifiedAt": "2023-11-07T05:31:56Z",
    "lastModifiedBy": "<string>"
  },
  "chatId": "<string>",
  "equipmentTypeId": "<string>",
  "serialNumber": "<string>",
  "objectId": "<string>",
  "inventoryNumber": 123,
  "lastMaintenanceDate": "2023-11-07T05:31:56Z",
  "purchaseDate": "2023-11-07T05:31:56Z",
  "tags": [
    "<string>"
  ],
  "chatName": "<string>"
}

Authorizations

x-API-Key
string
header
required

Path Parameters

id
string<objectid>
required

Equipment ID

Response

Equipment details

A single item of equipment that belongs to a specific equipment type Base class for all entities that can have a chat associated with them. Base class for all entities in the system, providing common properties and methods.

equipmentTypeId
string<objectid>
required

The EquipmentType this Equipment belongs to

objectId
string<objectid>
required

The Object (location) this equipment is located at

_id
string<objectid>

Unique identifier for the equipment Unique identifier of the entity

serialNumber
string

The serial number for this equipment

inventoryNumber
integer

The inventory number for this exact equipment

lastMaintenanceDate
string<date-time>

Last maintenance date

purchaseDate
string<date-time>

Purchase date

tags
string[]

Tags associated with the equipment

chatName
string

The name shown in notifications

number
integer

Unique number of the entity, used for identification

companyId
string<objectid>

The ID of the company this entity belongs to

status
object

Entity Status information

chatId
string<objectid> | null

ID of the chat associated with this entity