CLclickup
Time Tracking

Start a time Entry

Changed on

Start a timer for the authenticated user.

post/v2/team/{team_Id}/time_entries/start

Request

  • Base URL
    https://api.clickup.com/api
  • URL
    https://api.clickup.com/api/v2/team/{team_Id}/time_entries/start
  • Auth
    API key in header Authorization

Path parameters

team_Idnumber required
Example:123

Workspace ID

Query parameters

custom_task_idsboolean
Example:true

If you want to reference a task by it's custom task id, this value must be true.

team_idnumber
Example:123

When the custom_task_ids parameter is set to true, the Workspace ID must be provided using the team_id parameter.
For example: custom_task_ids=true&team_id=123.

Request body

descriptionstring
tidstring

You can provide a task ID to associate the time entry with a task. Unlimited uses of time entries that are not associated with tasks are available on the Business Plus and Enterprise Plan.

billableboolean

Example request

{
  "description": "from api",
  "tags": [
    {
      "name": "tag1"
    }
  ],
  "tid": "task_id",
  "billable": false
}

Response

Example response

{
  "data": {
    "id": "timer_id",
    "task": {
      "id": "task_id",
      "name": "test task",
      "status": {
        "status": "to do",
        "color": "#d3d3d3",
        "type": "open",
        "orderindex": 0
      },
      "custom_type": null
    },
    "wid": "workspace_id",
    "user": {
      "id": 1,
      "username": "first_name last_name",
      "email": "test@gmail.com",
      "color": "#08c7e0",
      "initials": "JK",
      "profilePicture": "https://attachments-public.clickup.com/profilePictures/1_HHk.jpg"
    },
    "billable": false,
    "start": "1595289395842",
    "duration": -53,
    "description": "",
    "tags": [],
    "at": 1595289452790
  }
}

Changes

  • a0a72ec97ddbRevision changes
    • breaking

      the / response's property type changed from no type to object for status

    • breaking

      the / response's property type changed from no type to object for status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status