WOworkiz
Tasks

Retrieve a list of Tasks

Changed on

Beta: Breaking changes may occur without notice.

Retrieves a paginated list of Tasks. Requires the Tasks add-on.

get/v2/task

Request

Query parameters

pageSizenumber
Example:10

Number of records to return per page.

pagenumber
Example:1

The page index.

field'start' | 'status'

Beta: This property is subject to change.

The field to sort results by. Must be combined with order.

order'ASC' | 'DESC'

Beta: This property is subject to change.

The sort direction. Must be combined with field. Defaults to DESC.

Headers

Authorizationstring required
Example:Bearer <token>

Bearer Token

Response

A paginated list of Tasks.

pageSizenumber

The maximum number of items returned per page.

pagenumber

The current page number.

totalResultsnumber

The total number of results.

hasMoreboolean

Whether there are more results.

Example response

{
  "pageSize": 10,
  "page": 1,
  "totalResults": 50,
  "hasMore": true,
  "data": [
    {
      "id": "TSK-3e6cca162914f48f",
      "title": "Doctor appointment",
      "description": "Doctor appointment with Dr. Smith",
      "start": "2024-07-25 09:00:00",
      "end": "2024-07-25 11:00:00",
      "tags": [
        {
          "id": "TAG-8cddc18e7b0458fa",
          "name": "Estimate"
        }
      ],
      "techIds": [
        "USR-83510a9930f203f4",
        "USR-a4f86bf1deefec12",
        "USR-d59dbcd34aa19dce"
      ],
      "parentId": "JOB-BA5r7o4bqzR9MONa",
      "updatedAt": "2024-07-25 09:00:00",
      "createdAt": "2024-07-25 09:00:00"
    }
  ]
}

Changes

  • fb557783146cRevision changes
    • warning

      removed the optional property //// from the response with the status

    • warning

      removed the optional property //// from the response with the status

    • info

      response property message list-of-types was narrowed by removing types array from media type application/json of response 403

  • bb1c25c92b05Revision changes
    • info

      endpoint added