Search CoworkerTasks

Search and list CoworkerTask records with filtering, sorting, and pagination.

GET /api/crm/coworkertasks

Search CoworkerTasks

cURL

curl --request GET \
  --url https://spaces.nexudus.com/api/crm/coworkertasks \
  --header 'Authorization: Basic <encoded-value>'

200

{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}

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

page · integer · default: "1"

The page number to retrieve.

size · integer · default: "25"

The number of records per page.

orderBy · string

The property name to sort results by (e.g. Name, CreatedOn).

dir · integer

Sort direction. 0 for ascending, 1 for descending.

Filters

CoworkerTask_Business · integer

Filter by Business Id.

CoworkerTask_Business_Name · string

Filter by location name.

CoworkerTask_Coworker · integer

Filter by Coworker Id.

CoworkerTask_Coworker_FullName · string

Filter by customer full name.

CoworkerTask_Coworker_CompanyName · string

Filter by customer company name.

CoworkerTask_Coworker_TeamNames · string

Filter by customer team names.

CoworkerTask_Name · string

Filter by task name.

CoworkerTask_Notes · string

Filter by additional details or instructions for the task.

CoworkerTask_TaskListName · string

Filter by name of the task list this task belongs to.

CoworkerTask_TaskItemUniqueId · string

Filter by unique identifier of the task item within a task list.

CoworkerTask_FormPageRequestUniqueId · string

Filter by unique identifier of the form page request that created this task.

CoworkerTask_Completed · boolean

Filter by whether the task has been marked as completed.

CoworkerTask_DueDate · string

Filter by due date for the task (UTC).

CoworkerTask_Reminded · boolean

Filter by whether a reminder has been sent for this task.

CoworkerTask_Responsible · integer

Filter by Responsible Id.

CoworkerTask_Responsible_FullName · string

Filter by responsible admin full name.

CoworkerTask_NotifyByEmail · boolean

Filter by whether to notify the responsible admin by email when the task is due.

CoworkerTask_DisplayToEveryone · boolean

Filter by whether the task is visible to all admin users.

CoworkerTask_DueDateLocal · string

Filter by due date for the task in the location’s local timezone.

Range Filters

from_CoworkerTask_DueDate · string

Filter by due date for the task (UTC) greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

to_CoworkerTask_DueDate · string

Filter by due date for the task (UTC) less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

from_CoworkerTask_DueDateLocal · 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.

to_CoworkerTask_DueDateLocal · 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.

from_CoworkerTask_CreatedOn · string

Filter records created on or after this date. Format: YYYY-MM-DDTHH:mm.

to_CoworkerTask_CreatedOn · string

Filter records created on or before this date. Format: YYYY-MM-DDTHH:mm.

from_CoworkerTask_UpdatedOn · string

Filter records updated on or after this date. Format: YYYY-MM-DDTHH:mm.

to_CoworkerTask_UpdatedOn · string

Filter records updated on or before this date. Format: YYYY-MM-DDTHH:mm.

Code Examples

Simple listing

cURL

curl -X GET \
  "https://spaces.nexudus.com/api/crm/coworkertasks?page=1&size=15&orderBy=Name&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

Filtering by Name

cURL

curl -X GET \
  "https://spaces.nexudus.com/api/crm/coworkertasks?CoworkerTask_Name=example-value&orderBy=Name&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

Range filters

cURL

curl -X GET \
  "https://spaces.nexudus.com/api/crm/coworkertasks?from_CoworkerTask_UpdatedOn=2025-01-01T00:00&to_CoworkerTask_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

200

Records · 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.

CurrentPage · integer

Current page number.

CurrentPageSize · integer

Number of records per page.

CurrentOrderField · string

The field used for sorting.

CurrentSortDirection · integer

The sort direction (0 = ascending, 1 = descending).

FirstItem · integer

Index of the first item on the current page.

LastItem · integer

Index of the last item on the current page.

TotalItems · integer

Total number of matching records across all pages.

TotalPages · integer

Total number of pages.

HasNextPage · boolean

Whether there is a next page of results.

HasPreviousPage · boolean

Whether there is a previous page of results.

Example Response

{
  "Records": [
    {
      "BusinessId": 0,
      "BusinessName": null,
      "CoworkerId": 0,
      "CoworkerFullName": null,
      "CoworkerCompanyName": null,
      "CoworkerTeamNames": null,
      "Name": "",
      "TaskListName": null,
      "TaskItemUniqueId": null,
      "FormPageRequestUniqueId": null,
      "Completed": false,
      "DueDate": null,
      "Reminded": false,
      "ResponsibleId": 0,
      "ResponsibleFullName": null,
      "DueDateLocal": null,
      "Id": 87654321,
      "UpdatedOn": "2025-01-15T10:30:00Z",
      "CreatedOn": "2025-01-10T08:00:00Z",
      "UniqueId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "UpdatedBy": "[e-mail]",
      "IsNew": false,
      "SystemId": null,
      "ToStringText": "CoworkerTask Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "Name",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}