CoworkerTasks
Search CoworkerTasks
Search and list CoworkerTask records with filtering, sorting, and pagination.
GET
Search CoworkerTasks
A CoworkerTask represents a to-do item that can be assigned to an admin user. Tasks help space managers and staff track daily operations such as onboarding steps, maintenance requests, or follow-ups.
Each task is linked to a customer (
CoworkerId) and assigned to a responsible admin (ResponsibleId). The responsible admin receives a notification on the Admin Panel and can mark the task as completed once done.
Tasks can optionally be grouped into task lists (TaskListName). Task lists standardise and partially automate admin processes — for example, a series of onboarding tasks (access card handout, locker keys, welcome tour) each assigned to a different admin.
Use NotifyByEmail to send an email reminder to the responsible admin when the task is due. Use DisplayToEveryone to make the task visible to all admin users, not just the responsible one.
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 CoworkerTask-List role.Query Parameters
Pagination & Sorting
The page number to retrieve.
The number of records per page.
The property name to sort results by (e.g.
Name, CreatedOn).Sort direction.
1 for ascending, -1 for descending.Filters
Filter by Business Id.
Filter by location name.
Filter by Coworker Id.
Filter by customer full name.
Filter by customer company name.
Filter by customer team names.
Filter by task name.
Filter by additional details or instructions for the task.
Filter by name of the task list this task belongs to.
Filter by unique identifier of the task item within a task list.
Filter by unique identifier of the form page request that created this task.
Filter by whether the task has been marked as completed.
Filter by due date for the task (UTC).
Filter by whether a reminder has been sent for this task.
Filter by Responsible Id.
Filter by responsible admin full name.
Filter by whether to notify the responsible admin by email when the task is due.
Filter by whether the task is visible to all admin users.
Filter by due date for the task in the location’s local timezone.
Range Filters
Filter by due date for the task (UTC) greater than or equal to this value. Format:
YYYY-MM-DDTHH:mm.Filter by due date for the task (UTC) less than or equal to this value. Format:
YYYY-MM-DDTHH:mm.Filter by due date for the task in the location’s local timezone greater than or equal to this value. Format:
YYYY-MM-DDTHH:mm.Filter by due date for the task in the location’s local timezone less than or equal to this value. Format:
YYYY-MM-DDTHH:mm.Filter records created on or after this date. Format:
YYYY-MM-DDTHH:mm.Filter records created on or before this date. Format:
YYYY-MM-DDTHH:mm.Filter records updated on or after this date. Format:
YYYY-MM-DDTHH:mm.Filter records updated on or before this date. Format:
YYYY-MM-DDTHH:mm.Code Examples
Simple listing
Filtering by Name
Range filters
Response
200
The list of CoworkerTask records matching the query. See the Get one CoworkerTask endpoint for the full list of properties returned for each record.
Current page number.
Number of records per page.
The field used for sorting.
The sort direction (
1 = ascending, -1 = descending).Index of the first item on the current page.
Index of the last item on the current page.
Total number of matching records across all pages.
Total number of pages.
Whether there is a next page of results.
Whether there is a previous page of results.
Example Response
Search CoworkerTasks