Skip to main content
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

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 business linked to this record.
string
Filter by location name.
integer
Filter by iD of the coworker linked to this record.
string
Filter by customer full name.
string
Filter by customer company name.
string
Filter by customer team names.
string
Filter by task name.
string
Filter by additional details or instructions for the task.
string
Filter by name of the task list this task belongs to.
string
Filter by unique identifier of the task item within a task list.
string
Filter by unique identifier of the form page request that created this task.
boolean
Filter by whether the task has been marked as completed.
string
Filter by due date for the task (UTC).
boolean
Filter by whether a reminder has been sent for this task.
integer
Filter by iD of the responsible linked to this record.
string
Filter by responsible admin full name.
boolean
Filter by whether to notify the responsible admin by email when the task is due.
boolean
Filter by whether the task is visible to all admin users.
string
Filter by due date for the task in the location’s local timezone.

Range Filters

string
Filter by due date for the task (UTC) greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.
string
Filter by due date for the task (UTC) less than or equal to this value. Format: YYYY-MM-DDTHH:mm.
string
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.
string
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.
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

CoworkerTask[]
The list of CoworkerTask records matching the query. See the Get one CoworkerTask endpoint for the full list of properties returned for each record.
Partial records — The listing endpoint returns a summary representation of each CoworkerTask. The following fields are not populated in the Records[] response: Notes, NotifyByEmail, DisplayToEveryone.To get all fields, fetch the full record using the Get one CoworkerTask endpoint.Important for updates: When updating a record via PUT, always retrieve the full record with a GET request first, apply your changes to that complete data, and then send the updated record. Do not use data from a listing response as the base for a PUT request, as missing fields may be unintentionally cleared.
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