v1

latestOpenAPI 3.1.02026-07-24172151607.6 KB
Time Tracking

Get time entries within a date range

View time entries filtered by start and end date.

By default, this endpoint returns time entries from the last 30 days created by the authenticated user.

To retrieve time entries for other users, you must include the assignee query parameter.

Only one of the following location filters can be included at a time: space_id, folder_id, list_id, or task_id.

Note: A time entry that has a negative duration means that timer is currently running for that user.

get/v2/team/{team_Id}/time_entries

Path parameters

team_Idnumber required
Example:123

Workspace ID

Query parameters

start_datenumber

Unix time in milliseconds

end_datenumber

Unix time in milliseconds

assigneenumber

Filter by user_id. For multiple assignees, separate user_id using commas.

Example: assignee=1234,9876

Note: Only Workspace Owners/Admins have access to do this.

include_task_tagsboolean

Include task tags in the response for time entries associated with tasks.

include_location_namesboolean

Include the names of the List, Folder, and Space along with the list_id,folder_id, and space_id.

include_approval_historyboolean

Include the history of the approval for each time entry. Adds status changes, notes, and approvers.

include_approval_detailsboolean

Include the details of the approval for each time entry. Adds Approver ID, Approved Time, List of Approvers, and Approval Status.

space_idnumber

Only include time entries associated with tasks in a specific Space.

folder_idnumber

Only include time entries associated with tasks in a specific Folder.

list_idnumber

Only include time entries associated with tasks in a specific List.

task_idstring

Only include time entries associated with a specific task.

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.

is_billableboolean
Example:true

Include only billable time entries by using a value of true or only non-billable time entries by using a value of false.

For example: ?is_billable=true.

Headers

Content-Type'application/json' required
Example:application/json

Response

If your time entry is associated with a task that uses custom task ids you can expect a `custom_id`` field in the body of the response. The task field will only be included if there is a task associated with a time entry.

Example response

{
  "data": [
    {
      "id": "1963465985517105840",
      "task": {
        "id": "1vwwavv",
        "custom_id": "JOSH-917",
        "name": "woof",
        "status": {
          "status": "open yes",
          "color": "#d3d3d3",
          "type": "open",
          "orderindex": 0
        },
        "custom_type": null
      },
      "wid": "300702",
      "user": {
        "id": 1,
        "username": "first_name last_name",
        "email": "test@gmail.com",
        "color": "#08c7e0",
        "initials": "JK",
        "profilePicture": "https://attachments.clickup.com/profilePictures/1_HHk.jpg"
      },
      "billable": false,
      "start": 1592841559129,
      "end": 1592845899021,
      "duration": "4339892",
      "description": "",
      "tags": [],
      "source": "clickup",
      "at": "1592845899021",
      "approval_id": "2d539936-119a-4927-9770-179f0a72e2e5",
      "approval": {
        "title": "Approval",
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Unique identifier for the approval"
          },
          "workspace_id": {
            "type": "integer",
            "description": "ID of the workspace this approval belongs to"
          },
          "status": {
            "type": "string",
            "description": "Current status of the approval (e.g., 'approved', 'pending')"
          },
          "data": {
            "type": "object",
            "properties": {
              "end_of_week": {
                "type": "integer",
                "description": "Timestamp for the end of the week"
              },
              "start_of_week": {
                "type": "integer",
                "description": "Timestamp for the start of the week"
              }
            }
          },
          "user": {
            "$ref": "#/paths/~1v2~1task~1%7Btask_id%7D~1time/get/responses/200/content/application~1json/schema/properties/data/items/properties/user"
          },
          "approvers": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "integer",
                  "description": "ID of the user who can approve the request"
                }
              }
            }
          },
          "approver_id": {
            "type": "integer",
            "description": "ID of the user who approved the request"
          },
          "approved_at": {
            "type": "integer",
            "description": "Timestamp when the approval was granted"
          },
          "history": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Unique identifier for the history entry"
                },
                "field": {
                  "type": "string",
                  "description": "Field that was changed"
                },
                "before": {
                  "type": "string",
                  "description": "Previous value"
                },
                "after": {
                  "type": "string",
                  "description": "New value"
                },
                "created_at": {
                  "type": "integer",
                  "description": "Timestamp when the change was made"
                },
                "user": {
                  "$ref": "#/paths/~1v2~1task~1%7Btask_id%7D~1time/get/responses/200/content/application~1json/schema/properties/data/items/properties/user"
                }
              }
            }
          }
        },
        "examples": [
          {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "workspace_id": 12345,
            "status": "approved",
            "data": {
              "end_of_week": 1672531199000,
              "start_of_week": 1671926400000
            },
            "user": {
              "id": 101,
              "username": "john.smith",
              "initials": "JS",
              "avatar": {
                "color": "#4287f5",
                "picture_url": null
              }
            },
            "approvers": [
              {
                "id": 101
              },
              {
                "id": 102
              }
            ],
            "approver_id": 101,
            "approved_at": 1672012800000,
            "history": [
              {
                "id": "987fcdeb-51a2-3456-789a-bcdef0123456",
                "field": "submission",
                "before": null,
                "after": null,
                "created_at": 1671987600000,
                "user": {
                  "id": 101,
                  "username": "john.smith",
                  "role": "submitter"
                }
              },
              {
                "id": "456abcde-f123-4567-89ab-cdef01234567",
                "field": "status",
                "before": "pending",
                "after": "approved",
                "created_at": 1672012800000,
                "user": {
                  "id": 102,
                  "username": "jane.doe",
                  "role": "approver"
                }
              }
            ]
          }
        ]
      },
      "task_location": {
        "list_id": 1560300071,
        "folder_id": 468300080,
        "space_id": 22800253,
        "list_name": "List",
        "folder_name": "Folder",
        "space_name": "Space"
      },
      "task_tags": [
        {
          "name": "content-request",
          "tag_fg": "#800000",
          "tag_bg": "#2ecd6f",
          "creator": 301828
        },
        {
          "name": "marketing-okr",
          "tag_fg": "#800000",
          "tag_bg": "#7C4DFF",
          "creator": 301828
        }
      ],
      "task_url": "https://staging.clickup.com/t/1vwwavv"
    }
  ]
}