Time entry

Add a new time entry

Changed on

Important: if workspace has time entry custom fields configured that are marked as required you must provide them in the customFields array.

post/v1/workspaces/{workspaceId}/time-entries

Request

  • Base URL: https://api.clockify.me/api
  • URL: https://api.clockify.me/api/v1/workspaces/{workspaceId}/time-entries
  • Auth: one of:
    • API key in header x-api-key
    • API key in header x-addon-token

Path parameters

workspaceIdstring required

Represents a workspace identifier across the system.

Example:64a687e29ae1f428e7ebe303

Request body

billableboolean

Indicates whether a time entry is billable or not.

descriptionstring

Represents time entry description.

endstring date-time

Represents an end date in yyyy-MM-ddThh:mm:ssZ format.

projectIdstring

Represents a project identifier across the system.

startstring date-time

Represents a start date in yyyy-MM-ddThh:mm:ssZ format.

tagIdsstring[]

Represents a list of tag ids.

taskIdstring

Represents a task identifier across the system.

type'REGULAR' | 'BREAK'

Valid time entry type.

Example request

{
  "customAttributes": [
    {
      "name": "Location",
      "namespace": "user_info",
      "value": "Belgrade"
    }
  ],
  "customFields": [
    {
      "customFieldId": "5e4117fe8c625f38930d57b7",
      "sourceType": "WORKSPACE"
    }
  ],
  "description": "This is a sample time entry description.",
  "end": "2021-01-01T00:00:00Z",
  "projectId": "25b687e29ae1f428e7ebe123",
  "start": "2020-01-01T00:00:00Z",
  "tagIds": [
    "321r77ddd3fcab07cfbb567y",
    "44x777ddd3fcab07cfbb88f"
  ],
  "taskId": "54m377ddd3fcab07cfbb432w"
}

Response

Created

billableboolean

Indicates whether a time entry is billable.

descriptionstring

Represents time entry description.

idstring

Represents time entry identifier across the system.

isLockedboolean

Represents whether time entry is locked for modification.

kioskIdstring

Represents kiosk identifier across the system.

projectIdstring

Represents project identifier across the system.

tagIdsstring[]

Represents a list of tag identifiers across the system.

taskIdstring

Represents task identifier across the system.

type'REGULAR' | 'BREAK' | 'HOLIDAY' | 'TIME_OFF'

Represents a time entry type enum.

userIdstring

Represents user identifier across the system.

workspaceIdstring

Represents workspace identifier across the system.

Example response

{
  "customFieldValues": [
    {
      "customFieldId": "5e4117fe8c625f38930d57b7",
      "name": "TIN",
      "timeEntryId": "64c777ddd3fcab07cfbb210c",
      "type": "WORKSPACE"
    }
  ],
  "description": "This is a sample time entry description.",
  "id": "64c777ddd3fcab07cfbb210c",
  "kioskId": "94c777ddd3fcab07cfbb210d",
  "projectId": "25b687e29ae1f428e7ebe123",
  "tagIds": [
    "321r77ddd3fcab07cfbb567y",
    "44x777ddd3fcab07cfbb88f"
  ],
  "taskId": "54m377ddd3fcab07cfbb432w",
  "timeInterval": {
    "duration": "8000",
    "end": "2021-01-01T00:00:00Z",
    "start": "2020-01-01T00:00:00Z",
    "timeZone": "America/New_York"
  },
  "type": "BREAK",
  "userId": "5a0ab5acb07987125438b60f",
  "workspaceId": "64a687e29ae1f428e7ebe303"
}

Changes

    • 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

      the request property default value was added

    • info

      the request property default value was added

    • info

      the request property default value was added

    • info

      the request property default value was added

    • info

      the request property default value was added

    • info

      the request property default value was added

    • info

      the request property default value was added

    • info

      the request property default value was added

    • info

      the request property default value was added

    • info

      the request property default value was added

    • info

      the response's property default value was added for the status

    • info

      the response's property default value was added for the status

    • info

      the response's property default value was added for the status

    • info

      the response's property default value was added for the status

    • info

      the response's property default value was added for the status

    • info

      the response's property default value was added for the status

    • info

      the response's property default value was added for the status

    • info

      the response's property default value was added for the status

    • info

      the response's property default value was added for the status

    • info

      the response's property default value was added for the status

    • info

      the response's property default value was added for the status

    • info

      the response's property default value was added for the status

    • info

      the response's property default value was added for the status

    • info

      the response's property default value was added for the status