Overview

This API endpoint allows users to start or finish employee tasks by updating their status. The endpoint is public and requires a minimum role of Employee.

Parameters

Parameter	Type	Description	Required
`employeeTaskId`	String	ULID-like string identifier for the employee task	✅ Mandatory
`status`	Integer	Task status: `1` for start, `2` for finish	✅ Mandatory

Permissions

Users can start or finish their own tasks within the allowed timeframe, or others' tasks if they have edit permissions over the shift to which the task belongs.

API Endpoints

Start Task

Endpoint: POST {baseUrl}/api/v2/employee-tasks/{employeeTaskId}/activity?access_token={token}

Request Body:

{
  "status": 1
}

Finish Task

Endpoint: POST {baseUrl}/api/v2/employee-tasks/{employeeTaskId}/activity?access_token={token}

Request Body:

{
  "status": 2
}

Response Format

Example Response:

{
    "status": 1,
    "data": {
        "activity": {
            "startedAt": "2025-10-06T09:38:33+00:00",
            "endedAt": "2025-10-07T10:31:47+00:00",
            "startedBy": 2,
            "endedBy": 2,
            "status": 2
        }
    },
    "metadata": [],
    "token": "token",
    "error": null
}

Response Fields

Field	Type	Description
`status`	Integer	Response status code
`data.activity.startedAt`	String	ISO 8601 timestamp when task was started
`data.activity.endedAt`	String	ISO 8601 timestamp when task was ended
`data.activity.startedBy`	Integer	User ID who started the task
`data.activity.endedBy`	Integer	User ID who ended the task
`data.activity.status`	Integer	Current task status (1 = started, 2 = finished)
`metadata`	Array	Additional metadata (typically empty)
`token`	String	Access token
`error`	Mixed	Error information (null if successful)