Skip to main content
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>'
{
  "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 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-Read role.

​
Path Parameters

​
id
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"

​
Response

​
200

​
BusinessId
integer
Business Id.
​
BusinessName
string
Location name.
​
CoworkerId
integer
Coworker Id.
​
CoworkerFullName
string
Customer full name.
​
CoworkerCompanyName
string
Customer company name.
​
CoworkerTeamNames
string
Customer team names.
​
Name
string
Task name.
​
Notes
string
Additional details or instructions for the task.
​
TaskListName
string
Name of the task list this task belongs to.
​
TaskItemUniqueId
string
Unique identifier of the task item within a task list.
​
FormPageRequestUniqueId
string
Unique identifier of the form page request that created this task.
​
Completed
boolean
Whether the task has been marked as completed.
​
DueDate
string
Due date for the task (UTC).
​
Reminded
boolean
Whether a reminder has been sent for this task.
​
ResponsibleId
integer
Responsible Id.
​
ResponsibleFullName
string
Responsible admin full name.
​
NotifyByEmail
boolean
Whether to notify the responsible admin by email when the task is due.
​
DisplayToEveryone
boolean
Whether the task is visible to all admin users.
​
DueDateLocal
string
Due date for the task in the location’s local timezone.
​
Id
integer
Unique record identifier.
​
UniqueId
string
UUID of the record.
​
CreatedOn
string
Date and time the record was created (ISO 8601).
​
UpdatedOn
string
Date and time the record was last updated (ISO 8601).
​
UpdatedBy
string
Email of the user who last updated this record.
​
IsNew
boolean
Whether the record was recently created.
​
SystemId
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
}