Task Resource

A task is a message type resource that represents an assignable task within a network. Tasks can be assigned to recipients, tracked, and marked as completed or ongoing.

Changelog

2025.0.0

Initial task management API documentation.

Endpoints

Representations

JSON Properties

Name	Type	Description
EID	EID	Unique entity identifier
title	string	The title of the task
taskType	string	The type of the task. One of: `associated`, `individual`, `shared`, `split`
author	object	The author/creator of the task
author.EID	EID	EID of the author
recipients	array	List of recipient objects (users, groups, or network)
recipients[i].EID	EID	EID of the recipient
recipients[i].type	string	`user`, `group`, or `network`
completed	boolean	Read-only Whether the task has been completed
completedAt	datetime	Read-only The date and time when the task was completed
completedBy	object	Read-only The user who completed the task
numAssignees	integer	Read-only The number of assignees for this task
numCompleted	integer	Read-only The number of assignees who have completed this task
dueDate	datetime	The due date for the task
created	datetime	Read-only The date the task was created
attachments	array	List of attachments associated with the task

Links

Relation	Resource	Description
recipients	recipient	Recipients
attachments	attachment	Attachments
author	user	Task author
completedBy	user	User who completed the task
assignees	user	Task assignees

Example (task)

{
    "_links": {
        "recipients": [
            {
                "href": "/networks/FEDCBA0987654321/users/1234567890ABCDEF/"
            }
        ],
        "attachments": {
            "href": "/networks/FEDCBA0987654321/messages/?eid=1234567890ABCDEF"
        },
        "assignees": {
            "href": "/networks/FEDCBA0987654321/messages/1234567890ABCDEF/assignees/"
        },
        "self": {
            "href": "/networks/FEDCBA0987654321/tasks/1234567890ABCDEF/"
        }
    },
    "EID": "1234567890ABCDEF",
    "title": "Pick up delivery",
    "taskType": "individual",
    "author": {
        "EID": "1234567890FEDCAB"
    },
    "recipients": [
        {
            "EID": "ABCDEF1234567890",
            "type": "user"
        }
    ],
    "completed": false,
    "completedAt": null,
    "completedBy": null,
    "numAssignees": 1,
    "numCompleted": 0,
    "dueDate": "2025-01-20T17:00:00.000+00:00",
    "created": "2025-01-15T10:30:00.000+00:00",
    "attachments": []
}