TaskItems
Search TaskItems
Search and list TaskItem records with filtering, sorting, and pagination.
GET
Search TaskItems
A TaskItem represents an individual task or to-do item that can be assigned to staff or customers. Tasks can be organised into lists, have due dates, and track completion status.
Authentication
This endpoint requires OAuth2 authentication. Include a valid bearer token in the
Authorization header.
The authenticated user must be a full unrestricted administrator or have the TaskItem-List role.Query Parameters
Pagination & Sorting
integer
default:"1"
The page number to retrieve.
integer
default:"25"
The number of records per page.
string
The property name to sort results by (e.g.
Name, CreatedOn).integer
Sort direction.
0 for ascending, 1 for descending.Filters
integer
Filter by iD of the task list linked to this record.
integer
Filter by iD of the responsible linked to this record.
string
Filter by display name of the linked responsible full (read-only).
string
Filter by the name value for this task item.
boolean
Filter by whether this task item is currently active.
boolean
Filter by whether notify by email is enabled.
boolean
Filter by whether display to everyone is enabled.
integer
Filter by the delay in hours value for this task item.
Range Filters
integer
Filter by the delay in hours value for this task item greater than or equal to this value.
integer
Filter by the delay in hours value for this task item less than or equal to this value.
string
Filter records created on or after this date. Format:
YYYY-MM-DDTHH:mm.string
Filter records created on or before this date. Format:
YYYY-MM-DDTHH:mm.string
Filter records updated on or after this date. Format:
YYYY-MM-DDTHH:mm.string
Filter records updated on or before this date. Format:
YYYY-MM-DDTHH:mm.Code Examples
Simple listing
Filtering by Name
Range filters
Response
200
TaskItem[]
The list of TaskItem records matching the query. See the Get one TaskItem endpoint for the full list of properties returned for each record.
integer
Current page number.
integer
Number of records per page.
string
The field used for sorting.
integer
The sort direction (
0 = ascending, 1 = descending).integer
Index of the first item on the current page.
integer
Index of the last item on the current page.
integer
Total number of matching records across all pages.
integer
Total number of pages.
boolean
Whether there is a next page of results.
boolean
Whether there is a previous page of results.
Example Response
Search TaskItems