Get tasks - Weeek Public API

Get tasks

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Query Params

day

string

optional

userId

string

optional

projectId

integer

optional

completed

boolean

optional

Show only completed

boardId

integer

optional

boardColumnId

integer

optional

type

string

optional

priority

integer

optional

0 - Low 1 - Medium 2 - High 3 - Hold

string

optional

Search text in title and description

perPage

integer

optional

offset

integer

optional

sortBy

enum<string>

optional

Sorts in ascending order of the specified parameter. To sort in descending order, prepend a minus sign to the parameter, for example -name

Allowed values:

nametypeprioritydurationoverduecreateddatestart

startDate

string

optional

dd.mm.yyyy Required with endDate

endDate

string

optional

dd.mm.yyyy Required with startDate

all

boolean

optional

Shows all tasks, including deleted and completed. If present, the completed parameter is ignored

Responses

🟢200OK

application/json

Body

success

boolean

optional

tasks

array[object (Task) {27}]

optional

integer

optional

parentId

integer | null

optional

title

string

optional

description

string | null

optional

duration

integer | null

optional

In minutes

overdue

integer

required

type

enum<string>

optional

Allowed values:

actionmeetcall

priority

integer | null

optional

0 - Low
1 - Medium
2 - High
3 - Hold

>= 0<= 3

isCompleted

boolean

optional

authorId

string

optional

ID of the user who created the task

userId

string | null

optional

ID of the user who is executing the task

locations

array[object (TaskLocation) {3}]

required

image

string | null

optional

isPrivate

boolean

optional

startDate

string <date> | null

optional

Start date of the task in Y-m-d format

startDateTime

string <date-time> | null

optional

Start date of the task in ISO 8601 format

dueDate

string <date> | null

optional

Due date of the task in Y-m-d format

dueDateTime

string <date-time> | null

optional

Due date of the task in ISO 8601 format

createdAt

string <date-time>

required

Date the task was created in ISO 8601 format

updatedAt

string <date-time>

required

Date the task was last updated in ISO 8601 format

tags

array[integer]

optional

subscribers

array[string]

optional

subTasks

array[integer]

optional

workloads

array [object {7}]

optional

timeEntries

array[object (Time entry) {6}]

required

customFields

array[object (CustomFieldValue) {6}]

optional

attachments

array[object (Attachment) {7}]

optional

hasMore

boolean

optional

Example

{
  "success": true,
  "tasks": [
    {
      "id": 0,
      "parentId": 0,
      "title": "string",
      "description": "string",
      "date": "string",
      "time": "string",
      "duration": 60,
      "type": "action",
      "priority": 0,
      "isCompleted": true,
      "authorId": "string",
      "userId": "string",
      "boardId": 0,
      "boardColumnId": 0,
      "projectId": 0,
      "image": "string",
      "isPrivate": true,
      "dateStart": "2019-08-24",
      "dateEnd": "2019-08-24",
      "timeStart": "14:15:22Z",
      "timeEnd": "14:15:22Z",
      "tags": [
        0
      ],
      "subscribers": [
        "string"
      ],
      "workloads": [
        {
          "id": "bc92d5f2-3aaf-49cc-8010-5007ced66ea6",
          "userId": "24d20bfa-bc7e-471e-8c17-a199734532dc",
          "type": 2,
          "date": "05.10.2022",
          "duration": 60,
          "workStartAt": null,
          "workEndAt": null
        }
      ]
    }
  ],
  "hasMore": true
}