CitoHRCitoHR
API Reference

Training API

Manage training records and track employee development through the CitoHR API.

Get Trainings

Retrieve training records with filtering and pagination.

GET /api/trainings

Query parameters:

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

Authorization: Requires valid session.

Create Training

Create a new training record.

POST /api/trainings

Request body: 

{
  "name": "First Aid Training",
  "typeId": "type-id",
  "categoryId": "category-id",
  "startDate": "2024-01-15T00:00:00.000Z",
  "endDate": "2024-01-16T00:00:00.000Z",
  "expiryDate": "2026-01-15T00:00:00.000Z",
  "providerId": "provider-id",
  "cost": 150.00,
  "notes": "Annual refresher course",
  "structuredUnits": 8,
  "unstructuredUnits": 0,
  "hours": 8
}

Get Training by ID

Retrieve a specific training record by ID.

GET /api/trainings/{id}

Update Training

Update a training record.

PUT /api/trainings/{id}

Update Training Status or Outcome

Update the status or outcome of a training record.

PATCH /api/trainings/{id}

Request body: 

{
  "status": "COMPLETED",
  "outcome": "PASSED"
}

Delete Training

Delete a training record.

DELETE /api/trainings/{id}

Get Training Categories

Retrieve available training categories.

GET /api/training-categories

Get Training Providers

Retrieve available training providers.

GET /api/training-providers

Get Training Types

Retrieve available training types.

GET /api/training-types