Clock-ins

Before you start

Send Accept: application/json and Authorization: Bearer YOUR_TOKEN to https://{subdomain}.talentohq.com. See API for authentication.

Path and query identifiers are UUID strings.

Successful list and create responses use 200. A successful delete uses 204 and has no body. Validation failures use 422. Missing or invalid tokens, and records that cannot be found, use 401.

List clock-ins

GET /api/v3/clock_ins

Returns clock-ins for the selected employee on the provided date. If no date is provided, it returns clock-ins for the current date.

Parameter	Type	Description
employee_id	string (UUID)	Employee id. Required.
date	string	Optional date (ISO-8601).

Response 200

[
  {
    "employee_id": "1ae2fd31-da27-434e-92f2-b8f4480b57a8",
    "employee_name": "Employee name",
    "start_at": "2024-05-06T19:16:00.000+02:00",
    "end_at": null,
    "in_progress": true,
    "schedule_id": "774e1d68-7e31-45ce-a18b-d39be5b2286c",
    "schedule_name": "Usual schedule",
    "on_call_assignment_id": null
  }
]

Create a clock-in

POST /api/v3/clock_ins

Creates a clock-in for the requested employee. If a clock-in is already active it clocks the employee out. Time cannot be in the future. task_id and activity_type are accepted on create; they are not returned on the clock-in object.

Parameter	Type	Description
employee_id	string (UUID)	Employee id. Required.

Request

{
  "employee_id": "1ae2fd31-da27-434e-92f2-b8f4480b57a8",
  "start_at": "2024-05-06T09:16:00.000+02:00",
  "end_at": "2024-05-06T19:08:00.000+02:00",
  "task_id": null,
  "activity_type": "work"
}

Response 200

{
  "employee_id": "1ae2fd31-da27-434e-92f2-b8f4480b57a8",
  "employee_name": "Employee name",
  "start_at": "2024-05-06T19:16:00.000+02:00",
  "end_at": null,
  "in_progress": true,
  "schedule_id": "774e1d68-7e31-45ce-a18b-d39be5b2286c",
  "schedule_name": "Usual schedule",
  "on_call_assignment_id": null
}

Delete clock-ins

DELETE /api/v3/clock_ins/{id}

The path id is required by the route. The action deletes every clock-in for employee_id on date, not a single clock-in id.

Parameter	Type	Description
id	string	Path id required by the route.
employee_id	string (UUID)	Employee id. Required.
date	string	Date (ISO-8601) whose clock-ins should be deleted.

Response 204

The response has no body.