Sign in

v1

latestOpenAPI 3.1.02026-07-26549156879.0 KB
ProjectManagement > TimeRecord

Reads a single Time record

What does it do?

This endpoint reads and retrieves a list of time records. You can utilize URL parameters to filter the results.

What params does it accept?
  • ids: retrieve only the time records that matches the ids passed in the request.
  • project_workers_ids: Retrieve only the time records assigned to any project_workers_ids passed in the request.
  • subproject_ids: retrieve only the time records related with any subproject_ids passed in the request.
  • attendance_shift_ids: retrieve only the time records related with any attendance_shift_ids passed in the request.
  • employee_ids: ⚠️ This param, will be deprecated soon. Please use project_worker_ids param instead.
  • month: Filter time records created in a specific month of the year.
  • year: To be used with the month parameter to filter time records created in a particular period.
  • updated_after: this parameter is needed to filter time records created or updated after a date.
Is it related to other entities?

A time_record is mandatory related to a project_worker_id and an attendance_shift_id. Optionally, it can be related to a subproject.

Who can use it?

Only companies who have enabled the projects_management feature and users with the permission to read time_records.

get/api/2026-07-01/resources/project_management/time_records/{id}

Path parameters

idstring required

Time record ids to retrieve

Response

OK

idstring required

Id of the time record

project_worker_idstring required

Id of the project worker

attendance_shift_idstring

Id of the attendance shift

subproject_idstring

Id of the subproject

datestring

Reference date of the shift

imputed_minutesinteger

Minutes difference between the clock in and clock out

clock_instring

Clock in time

clock_outstring

Clock out time

observationsstring

Comment for the time record

Example response

{
  "id": "1",
  "project_worker_id": "1",
  "attendance_shift_id": "1",
  "subproject_id": "1",
  "date": "2021-01-01",
  "imputed_minutes": 480,
  "clock_in": "2021-01-01T08:00:00Z",
  "clock_out": "2021-01-01T17:00:00Z",
  "observations": "Comment for the time record"
}