Personal Tasks

Get all tasks

Changed on

Retrieve all tasks with optional filters and grouping

get/v1/tasks

Request

  • Base URL
    https://api.astravue.com
  • URL
    https://api.astravue.com/v1/tasks
  • Auth
    none declared. Required headers: X-Org-Id

Query parameters

titlestring

Title of the task

statusstring[]
prioritystring[]
tagsstring[]
creatorsinteger[]
ownersinteger[]
startDatestring date-time

Start date

dueDatestring date-time

Due date

createdTimestring date-time

Created time

modifiedTimestring date-time

Modified time

overdueboolean

Whether the task is overdue

dueDateSetboolean

Whether the due date is set

pendingboolean

Whether the task is pending

upcomingboolean

Whether the task is upcoming

customFieldsstring

Custom fields filter as JSON string. Conditions: IS, ISNOT, CONTAINS, NOTCONTAINS, STARTSWITH, ENDSWITH, ISEMPTY, ISNOTEMPTY, and on fields of type DATE also BEFORE, AFTER, BETWEEN, NOTBETWEEN, TODAY and TOMORROW. Date values are epoch milliseconds; BETWEEN and NOTBETWEEN take two, TODAY and TOMORROW take none.

pageinteger

Zero-based page index (0..N)

sizeinteger

The size of the page to be returned

sortstring[]

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

Headers

X-Org-Idinteger required

Organization ID

Response

Tasks fetched successfully

successboolean

Indicates if the operation was successful

messagestring

Message describing the result of the operation

codeinteger

HTTP status code of the response

timestampstring date-time

Timestamp of the response

Changes

  • 237f5bbd4029Revision changes
    • breaking

      for the query request parameter page, default value 0 was added

    • breaking

      for the query request parameter size, default value 20 was added

    • breaking

      the /////// response's property type changed from object to no type for status

    • info

      for the query request parameter page, the format was generalized from int32 to no format

    • info

      for the query request parameter size, the format was generalized from int32 to no format

    • info

      added the optional property /// to the response with the status