Get Equipments

Retrieves a list of equipment with optional filtering, sorting, and pagination.

Endpoint

GET /equipments

Authentication

Required: Authorization header with valid token

Query Parameters

ParameterTypeRequiredDescriptionExample
sortBystringNoField to sort byupdatedAt
sortDirectionstringNoSort directionDESC
updatedAfterdate-timeNoFilter equipment updated after this date2024-01-01T00:00:00Z
searchstringNoSearch term for equipment title/descriptionexcavator
activebooleanNoFilter by active statustrue
invNumberstringNoFilter by inventory numberINV-001
pagenumberNoPage number (default: 1)1
limitnumberNoItems per page (default: 20)20

Response

Success

{
  "content": [
    "EquipmentEntity"
  ],
  "total": "number"
}

Response Field Descriptions:

  • content - Array of equipment objects (EquipmentEntity Schema)
  • total - Total number of equipment matching the query criteria

Example Usage

curl -X GET "https://integration-api.ram.syniotec.com/master-data/v1/equipment-management/equipments?active=true&page=1&limit=10" \
  -H "Authorization: Bearer YOUR_TOKEN"