Sign in

v1

latestOpenAPI 3.1.02026-07-26549156879.0 KB
Trainings > Training

Reads all Trainings

Reads all Trainings

get/api/2026-07-01/resources/trainings/trainings

Query parameters

idstring

This field is used to get a specific training.

This field is used to get a specific training.

ids[]string[]

This field is used to filter those trainings whose id match with the given.

This field is used to filter those trainings whose id match with the given.

access_idstring

@deprecated

@deprecated

searchstring

This field is used to search in the training name, training description or training category.

This field is used to search in the training name, training description or training category.

statusstring

This field is used to filter those trainings whose status is the same as the one we pass.

This field is used to filter those trainings whose status is the same as the one we pass.

catalogboolean

This field is used to filter those trainings whose are visible in the catalog.

This field is used to filter those trainings whose are visible in the catalog.

only_assignedboolean

This field is used to filter those trainings whose attendance status is different from not assigned.

This field is used to filter those trainings whose attendance status is different from not assigned.

with_expired_membershipsboolean

This field is used to filter those trainings whose members have the course expired (if 'true') or not (if 'false').

This field is used to filter those trainings whose members have the course expired (if 'true') or not (if 'false').

return_expired_membershipsboolean

Fills the information of the field 'number_of_expired_participants' if 'true'

Fills the information of the field 'number_of_expired_participants' if 'true'

is_mandatoryboolean

This field is used to filter by mandatory or non-mandatory trainings if provided

This field is used to filter by mandatory or non-mandatory trainings if provided

with_current_training_classesboolean

This field is used to filter those trainings whose have current training classes if 'true'

This field is used to filter those trainings whose have current training classes if 'true'

Response

OK

Example response

{
  "data": [
    {
      "id": "1",
      "company_id": "1",
      "author_id": "20",
      "author_employee_id": "15",
      "name": "Communication Course",
      "code": "COM-101",
      "description": "Intermediate-level communication course that focuses on building and enhancing language skills.",
      "created_at": "2025-02-04T10:31:48.000Z",
      "updated_at": "2025-02-04T10:31:48.000Z",
      "total_cost_decimal": "0.0",
      "cost_decimal": "0.0",
      "subsidized_cost_decimal": "0.0",
      "category_ids": [
        "1",
        "20"
      ],
      "status": "active",
      "year": 2025,
      "catalog": true,
      "competency_ids": [
        "1",
        "3"
      ],
      "total_training_cost": "0.0",
      "total_training_indirect_cost": "0.0",
      "total_training_salary_cost": "0.0",
      "total_training_subsidized_cost": "0.0",
      "training_attendance_status": "completed",
      "objectives": "Build and enhance language skills.",
      "number_of_expired_participants": 2,
      "total_duration": 2.5
    }
  ]
}