List tasks

get

https://{backendUrlScheme}://{backendUrlHost}/api/public/task

This endpoint retrieves a list of tasks. At least one of _id, status, plannedDate, taskTypeId, tagId or _updatedAt must be provided.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

_id

array of strings

Task ID(s)

_id

taskTypeId

string

Task type ID

tagId

Tag ID or list of tag IDs. When multiple tag IDs are provided, tasks matching any of the provided tag IDs are returned

groupId

array of strings

Group ID(s)

groupId

_updatedAt

string

Selector object for updated at timestamp — supports $gt (greater than) and $lt (less than) attributes using Unix timestamp(s) in milliseconds - maximum allowed range is 365 days

status

string

Task status (e.g., open, confirmed, completed)

plannedForUserIds

array of strings

List of user IDs

plannedForUserIds

plannedDate

string

Selector object for planned date timestamp — supports $gt (greater than) and $lt (less than) attributes using Unix timestamp(s) in milliseconds - maximum allowed range is 365 days

skip

integer

Skip from index count (default: 0)

limit

integer

Number of items (default: 100, max: 1000)

sort

string

Field(s) to sort by (sort options : 1 for ascending, -1 for descending)

Headers

bsy-sid

string

required

Session ID

Responses

200Tasks retrieved successfully

400Bad request, missing required fields or invalid data

401Unauthorized access, invalid or missing session ID