Search CoworkerTasks

GET

api

crm

coworkertasks

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

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/crm/coworkertasks', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

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

A task is an operational to-do item for a customer, assigned to an admin user with optional due-date email reminders and visibility to the wider admin team.

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 location that owns this task..

string

Filter by display value for Business.Name..

integer

Filter by iD of the customer this task concerns..

string

Filter by display value for Coworker.FullName..

string

Filter by display value for Coworker.CompanyName..

string

Filter by display value for Coworker.TeamNames..

string

Filter by required task title..

string

Filter by optional instructions or context for completing the task..

string

Filter by read-only name of the task list from which this task was created, when applicable..

string

Filter by internal correlation GUID for the task-list item that created this task; managed by the originating workflow..

string

Filter by internal correlation GUID for the form submission that created this task; managed by the form workflow..

boolean

Filter by whether the task is complete; completed tasks are excluded from reminder processing and each user’s active-task list..

string

Filter by optional due date and time stored in UTC; an email reminder becomes eligible at or after this time when notifications are enabled..

boolean

Filter by internal flag indicating that the due-date email reminder was queued; task updates reset it to false..

integer

Filter by iD of the admin user responsible for completing this task; required when creating a task..

string

Filter by display value for Responsible.FullName..

boolean

Filter by whether to send the responsible admin an email reminder once the due date is reached; no reminder is sent without a due date..

boolean

Filter by whether the task appears in every admin user’s active-task list instead of only the responsible admin’s list..

string

Filter by read-only location-local representation derived from DueDate; set DueDate instead..

Range Filters

string

Filter by optional due date and time stored in UTC; an email reminder becomes eligible at or after this time when notifications are enabled. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by optional due date and time stored in UTC; an email reminder becomes eligible at or after this time when notifications are enabled. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by read-only location-local representation derived from DueDate; set DueDate instead. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by read-only location-local representation derived from DueDate; set DueDate instead. 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

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

const response = await fetch(
  'https://spaces.nexudus.com/api/crm/coworkertasks?' + new URLSearchParams({
    page: 1,
    size: 15,
    orderBy: 'Name',
    dir: 1 // Ascending
  }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/crm/coworkertasks',
    params={
        'page': 1,
        'size': 15,
        'orderBy': 'Name',
        'dir': 0 // Ascending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Filtering by Name

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

const response = await fetch(
  'https://spaces.nexudus.com/api/crm/coworkertasks?' + new URLSearchParams({
    CoworkerTask_Name: 'example-value',
    orderBy: 'Name',
    dir: 1
  }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/crm/coworkertasks',
    params={
        'CoworkerTask_Name': 'example-value',
        'orderBy': 'Name',
        'dir': 0 // Ascending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Range filters

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"

const response = await fetch(
  'https://spaces.nexudus.com/api/crm/coworkertasks?' + new URLSearchParams({
    from_CoworkerTask_UpdatedOn: '2025-01-01T00:00',
    to_CoworkerTask_UpdatedOn: '2025-12-31T23:59',
    orderBy: 'UpdatedOn',
    dir: 1 // Descending
   }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/crm/coworkertasks',
    params={
        'from_CoworkerTask_UpdatedOn': '2025-01-01T00:00',
        'to_CoworkerTask_UpdatedOn': '2025-12-31T23:59',
        'orderBy': 'UpdatedOn',
        'dir': 1 // Descending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

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

{
  "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": "admin@example.com",
      "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
}

Search CoworkerTasks

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

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/crm/coworkertasks', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

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

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Query Parameters

Filters

Range Filters

Code Examples

Simple listing

Filtering by Name

Range filters

Response

200

​Authentication

​Query Parameters

​Pagination & Sorting

​Filters

​Range Filters

​Code Examples

​Simple listing

​Filtering by Name

​Range filters

​Response

​200

Authentication

Query Parameters

Pagination & Sorting

Filters

Range Filters

Code Examples

Simple listing

Filtering by Name

Range filters

Response

200