Task

Find tasks on a project

Changed on
get/v1/workspaces/{workspaceId}/projects/{projectId}/tasks

Request

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

Path parameters

projectIdstring required

Represents a project identifier across the system.

Example:25b687e29ae1f428e7ebe123
workspaceIdstring required

Represents a workspace identifier across the system.

Example:64a687e29ae1f428e7ebe303

Query parameters

namestring

If provided, you'll get a filtered list of tasks that matches the provided string in their name.

Example:Bugfixing
strict-name-searchboolean

Flag to toggle on/off strict search mode. When set to true, search by name only will return tasks whose name exactly matches the string value given for the 'name' parameter. When set to false, results will also include tasks whose name contain the string value, but could be longer than the string value itself. For example, if there is a task with the name 'applications', and the search value is 'app', setting strict-name-search to true will not return that task in the results, whereas setting it to false will.

is-activeboolean

Filters search results whether task is active or not.

pageinteger

Page number.

Example:1
page-sizeinteger

Page size.

Example:50
sort-column'ID' | 'NAME'

Represents the column as criteria for sorting tasks.

sort-order'ASCENDING' | 'DESCENDING'

Sorting mode.

Response

OK

TaskDtoV1[] required(unresolved $ref)

Changes

    • breaking

      for the query request parameter name, 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