Get one CoworkerTask

GET

api

crm

coworkertasks

{id}

Get one CoworkerTask

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

import requests

url = "https://spaces.nexudus.com/api/crm/coworkertasks/{id}"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

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

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

{
  "BusinessId": 123,
  "BusinessName": "<string>",
  "CoworkerId": 123,
  "CoworkerFullName": "<string>",
  "CoworkerCompanyName": "<string>",
  "CoworkerTeamNames": "<string>",
  "Name": "<string>",
  "Notes": "<string>",
  "TaskListName": "<string>",
  "TaskItemUniqueId": "<string>",
  "FormPageRequestUniqueId": "<string>",
  "Completed": true,
  "DueDate": "<string>",
  "Reminded": true,
  "ResponsibleId": 123,
  "ResponsibleFullName": "<string>",
  "NotifyByEmail": true,
  "DisplayToEveryone": true,
  "DueDateLocal": "<string>",
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

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-Read role.

Path Parameters

integer

required

The Id of the CoworkerTask record to retrieve.

Code Examples

curl -X GET \
  "https://spaces.nexudus.com/api/crm/coworkertasks/87654321" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/crm/coworkertasks/87654321',
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const record = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/crm/coworkertasks/87654321',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

record = response.json()

Response

200

integer

ID of the location that owns this task..

string

Display value for Business.Name..

integer

ID of the customer this task concerns..

string

Display value for Coworker.FullName..

string

Display value for Coworker.CompanyName..

string

Display value for Coworker.TeamNames..

string

Required task title..

string

Optional instructions or context for completing the task..

string

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

string

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

string

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

boolean

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

string

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

boolean

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

integer

ID of the admin user responsible for completing this task; required when creating a task..

string

Display value for Responsible.FullName..

boolean

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

boolean

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

string

Read-only location-local representation derived from DueDate; set DueDate instead..

integer

Unique record identifier.

string

UUID of the record.

string

Date and time the record was created (ISO 8601).

string

Date and time the record was last updated (ISO 8601).

string

Email of the user who last updated this record.

boolean

Whether the record was recently created.

string

External system identifier.

Example Response

{
  "BusinessId": 0,
  "BusinessName": null,
  "CoworkerId": 0,
  "CoworkerFullName": null,
  "CoworkerCompanyName": null,
  "CoworkerTeamNames": null,
  "Name": "",
  "Notes": null,
  "TaskListName": null,
  "TaskItemUniqueId": null,
  "FormPageRequestUniqueId": null,
  "Completed": false,
  "DueDate": null,
  "Reminded": false,
  "ResponsibleId": 0,
  "ResponsibleFullName": null,
  "NotifyByEmail": false,
  "DisplayToEveryone": false,
  "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
}

Get one CoworkerTask

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

import requests

url = "https://spaces.nexudus.com/api/crm/coworkertasks/{id}"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

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

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

{
  "BusinessId": 123,
  "BusinessName": "<string>",
  "CoworkerId": 123,
  "CoworkerFullName": "<string>",
  "CoworkerCompanyName": "<string>",
  "CoworkerTeamNames": "<string>",
  "Name": "<string>",
  "Notes": "<string>",
  "TaskListName": "<string>",
  "TaskItemUniqueId": "<string>",
  "FormPageRequestUniqueId": "<string>",
  "Completed": true,
  "DueDate": "<string>",
  "Reminded": true,
  "ResponsibleId": 123,
  "ResponsibleFullName": "<string>",
  "NotifyByEmail": true,
  "DisplayToEveryone": true,
  "DueDateLocal": "<string>",
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Path Parameters

Code Examples

Response

200

​Authentication

​Path Parameters

​Code Examples

​Response

​200

Authentication

Path Parameters

Code Examples

Response

200