CitoHRCitoHR
API Reference

Equipment API

Track and manage equipment assignments to employees through the CitoHR API.

Get Equipment

Retrieve equipment list with filtering and pagination.

GET /api/equipment

Query parameters:

  • type - Filter by equipment type (optional)
  • page - Page number (default: 1)
  • pageSize - Items per page (default: 10)
  • search - Search equipment by name (optional)
  • sortBy - Sort field (default: dateGiven)
  • sortOrder - Sort order: asc or desc (default: desc)

Authorization: Requires valid session. Returns equipment accessible to the current user.

Create Equipment

Create a new equipment assignment. Requires ADMIN role.

POST /api/equipment

Request body: 

{
  "name": "MacBook Pro 16",
  "type": "LAPTOP",
  "serialNumber": "ABC123456",
  "userId": "user-id",
  "dateGiven": "2024-01-15T00:00:00.000Z",
  "notes": "Company laptop"
}

Get Equipment by ID

Retrieve a specific equipment item by ID.

GET /api/equipment/{id}

Update Equipment

Update an equipment assignment. Requires ADMIN role.

PUT /api/equipment/{id}

Return Equipment

Mark equipment as returned. Requires ADMIN role.

POST /api/equipment/{id}/return

Delete Equipment

Delete an equipment record. Requires ADMIN role.

DELETE /api/equipment/{id}

Get Equipment Statistics

Retrieve equipment statistics and analytics.

GET /api/equipment/stats