Skip to main content
GET
List equipment

Authorizations

x-API-Key
string
header
required

Query Parameters

limit
integer
default:100

Maximum number of items to return

Required range: 1 <= x <= 1000
offset
integer
default:0

Number of items to skip for pagination

Required range: x >= 0
sort
string

Sort field and direction (e.g. serialNumber:1, nextMaintenanceDate:-1)

equipmentBySerialNumberOrName
string

Filter by equipment serial number or name (partial match)

objectIds
string<objectid>[]

Filter by object IDs

equipmentByCategory
string[]

Filter by equipment type category

tags
string[]

Filter by tags

generalField
object

A dynamic filter that allows filtering on any field with various operators. Supports string, number, boolean, date, and objectid field types.

status
string

Filter by status (single value or comma-separated list)

name
string

Filter by name (partial match, supports full name or number)

ids
string<objectid>[]

Filter by IDs (array of objectIds)

Response

List of equipment

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

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

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