Sign in

v1

latestOpenAPI 3.1.02026-07-26294215839.4 KB
Training
Public API

Create Employee Training Record

Creates a new training record for the specified employee. The 'completed' date (yyyy-mm-dd) and 'type' (training type ID) are required. Optional fields include instructor, hours, credits, notes, and cost. The authenticated caller must have permission to add trainings for the employee.

OAuth Scopes: training.write

post/api/v1/training/record/employee/{employeeId}

Path parameters

employeeIdinteger required

The internal employee ID of the employee to add a training record to.

Request body

completedstring required

Completed is a required field and must be in yyyy-mm-dd format.

instructorstring

Name of the training instructor.

hoursnumber

Number of hours for the training.

creditsnumber

Credits earned for the training.

notesstring

Optional notes about the training record.

typeinteger required

This must be an existing training type ID.

Example request

{
  "completed": "2026-03-12",
  "cost": {
    "currency": "USD",
    "amount": "100.00"
  },
  "instructor": "Bob Jones",
  "hours": "16",
  "credits": "4",
  "notes": "sample note",
  "type": "4"
}

Response

Created

idinteger

The ID of the training record.

employeeIdstring

The internal employee ID of the employee associated with the training, returned as a string.

completedstring date

Completed is a date in the format yyyy-mm-dd.

notesstring nullable

Notes left on the training record. Null when not set.

instructorstring nullable

Name of the instructor. Null when not set or when disabled by company training settings.

creditsstring nullable

Credits earned for the training record, returned as a string. Null when not set or when disabled by company training settings.

hoursstring nullable

Hours associated with the training record, returned as a string. Null when not set or when disabled by company training settings.

coststring nullable

The cost in the format '{amount} {currency}', e.g. '50.00 USD'. May be null or empty string when not set.