Tasks

Properties

idstring

The id of the task.

archivedBystring

The uuid of the user who archived the task.

archivedDatestring

The date the task was archived in RFC3339 format.

internalUserIdstring

The uuid of the internal user whom this task is assigned to, empty if task is not assigned to internal user (see clientId/companyId fields instead).

clientIdstring

The uuid of the client user whom this task is assigned to, empty if task is not assigned to client user (see internalUserId/companyId fields instead).

companyIdstring

The uuid of the company whom this task is assigned to, empty if task is assigned to an internal user, if clientId is not empty this company uuid is the client’s company id.

completedBystring

The uuid of the user who completed the task.

completedByUserTypestring

The type of user who completed the task.

completedDatestring

The date the task was completed in RFC3339 format.

createdBystring

The uuid of the user who created the task.

createdDatestring

The date the task was created in RFC3339 format.

creatorTypestring

The type of user who created the task.

deletedBystring

The uuid of the user who deleted the task.

deletedDatestring

The date the task was deleted in RFC3339 format.

descriptionstring

The description of the task in HTML format.

dueDatestring

The date the task is due in RFC3339 format.

isArchivedboolean

Whether or not the task has been archived.

isDeletedboolean

Whether or not the task has been deleted.

labelstring

The label for the task, e.g. OUT-123.

namestring

The name of the task, also known as the title.

objectstring

Object type [task].

parentTaskIdstring

The parent task id of the task, if task is a subtask.

sourcestring

The source of where the task was created from, web (webapp) or api.

statusstring

The status of the task, one of todo, inProgress, or completed.

templateIdstring

The template id this task was created from. Empty if task was not created from a template.

viewersarray of objects

The uuid of the company or client that you would like to grant viewing access to the task. Empty if there are no viewers. Currently, only one entity (either a client or a company) can be added as a viewer per task. If the task viewer is a client, you must add both the clientId and their companyId. If the task viewer is a company, you must only add the companyId (leave clientId empty).

attachmentsarray of objects

All of the attachments in a task.

Example Task Object

{
    "archivedBy": null,
    "archivedDate": null,
    "clientId": "9eee4ba8-0b5e-47c6-8a4b-53022fbc7875",
    "companyId": "122341fa-wgj5-32hn-34hs-9023jnmgas0b",
    "internalUserId": null,
    "completedBy": null,
    "completedByUserType": null,
    "completedDate": null,
    "createdBy": "27024189-ea18-40a7-a5cf-48579c352dee",
    "createdDate": "2025-05-06T15:22:37Z",
    "creatorType": "internalUser",
    "deletedBy": null,
    "deletedDate": null,
    "description": "Task desc",
    "dueDate": null,
    "id": "eddeb6a1-dfd7-4a60-9c8c-38ceed09bde9",
    "isArchived": false,
    "isDeleted": false,
    "label": "POC-013",
    "name": "Task from marketplace api",
    "object": "task",
    "parentTaskId": null,
    "source": "api",
    "status": "todo",
    "templateId": null,
    "viewers": [
        {
          "clientId": "987e6543-e21b-12d3-a456-426614174111",
          "companyId": "456e7890-e12b-12d3-a456-426614174222"
        }
      ],
    "attachments": [
        {
          "id": "eddeb6a1-dfd7-4a60-9c8c-38ceed09bde9",
          "fileName": "expense_template.xlsx",
          "fileSize": 12044,
          "mimeType": "application/vnd.sheet",
          "downloadUrl": "https://...",
          "uploadedBy": "27024189-ea18-40a7-a5cf-48579c352dee",
          "uploadedByUserType": "internalUser",
          "uploadedDate": "2025-05-06T15:22:37Z"
        }
      ]
}