GET
/
equipment
/
List equipment
curl --request GET \
  --url http:localhost:3000/v2/equipment/ \
  --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

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

200
application/json

List of equipment

The response is of type Equipment · object[].