*REST API › Objects › Operations*

# Task

> The task, as returned by the API.

A task or schedule event, with its dates, whether it is all-day, completed or recurring, the staff assigned to it and the document it relates to. Tasks are bounded to the subscription that owns the key. The delivery and return tasks that a reservation creates are removed by cancelling the order, not by deleting them here.

Schemas: `TaskDto`

## Attributes

| Name | Type | Description |
| --- | --- | --- |
| `id` | string | Unique task identifier. |
| `title` | string | Task title. |
| `description` | string | Task description or notes; null if it has none. |
| `startDate` | string<date-time> | Start date and time in ISO 8601 with offset. |
| `endDate` | string<date-time> | End date and time in ISO 8601 with offset; null if it has no defined end. |
| `isAllDay` | boolean | Whether the task is all-day. |
| `isCompleted` | boolean | Whether the task is completed. |
| `isRecurring` | boolean | Whether the task is part of a recurring series. |
| `recurringGroupId` | string | Identifier of the recurrence group it belongs to; null if it is not recurring. |
| `recurrencePattern` | object | Recurrence pattern of the task; null if it is not recurring. |
| `recurrencePattern.frequency` | string | Recurrence frequency: daily, weekly, monthly or yearly. `daily`, `weekly`, `monthly`, `yearly` |
| `recurrencePattern.interval` | integer | Interval between repetitions according to the frequency (e.g. 2 with weekly = every two weeks). |
| `recurrencePattern.endAfterOccurrences` | integer | Number of repetitions after which the recurrence ends; null if it does not end by number of occurrences. |
| `recurrencePattern.endDate` | string<date-time> | Date on which the recurrence ends, in ISO 8601 with offset; null if it does not end by date. |
| `type` | string | Task type (identifier of the type). |
| `assignedStaffIds` | string[] | Identifiers of the staff assigned to the task. |
| `projectId` | string | Identifier of the linked project; null if the task is not linked. |
| `relatedDocumentId` | string | Identifier of the related document; null if it has none. |
| `relatedDocumentType` | string | Type of the related document (contact, order, invoice, quote, project, etc.); null if it has none. |
| `appearance` | object | Appearance of the task in the schedule (color and variant). |
| `appearance.color` | string | Task color in the schedule (hexadecimal code). |
| `appearance.variant` | string | Visual variant of the task: primary, secondary, destructive or default. `primary`, `secondary`, `destructive`, `default` |
| `createdAt` | string<date-time> | Creation date in ISO 8601 with offset. |
| `updatedAt` | string<date-time> | Last update date in ISO 8601 with offset. |

## Example

*Task · Generated from the schema*

```json
{
  "id": "id_8f2a1c",
  "title": "Example",
  "description": "string",
  "startDate": "2026-09-01T08:00:00Z",
  "endDate": "2026-09-01T08:00:00Z",
  "isAllDay": true,
  "isCompleted": true,
  "isRecurring": true,
  "recurringGroupId": "string",
  "recurrencePattern": {
    "frequency": "daily",
    "interval": 1,
    "endAfterOccurrences": 1,
    "endDate": "2026-09-01T08:00:00Z"
  },
  "type": "string",
  "assignedStaffIds": [
    "string"
  ],
  "projectId": "string",
  "relatedDocumentId": "string",
  "relatedDocumentType": "string",
  "appearance": {
    "color": "string",
    "variant": "primary"
  },
  "createdAt": "2026-09-01T08:00:00Z",
  "updatedAt": "2026-09-01T08:00:00Z"
}
```

## Returned by

- [`GET /api/v1/tasks`](https://docs.filmo.io/rest-api/endpoint-reference/tasks/list-tasks) — List tasks
- [`GET /api/v1/tasks/{taskId}`](https://docs.filmo.io/rest-api/endpoint-reference/tasks/get-a-task) — Get a task

## Modified by

- [`POST /api/v1/tasks`](https://docs.filmo.io/rest-api/endpoint-reference/tasks/create-a-task) — Create a task
- [`PATCH /api/v1/tasks/{taskId}`](https://docs.filmo.io/rest-api/endpoint-reference/tasks/update-a-task) — Update a task

---

Canonical URL: https://docs.filmo.io/rest-api/objects/task  
Last updated: 2026-10-25