Operations

Task

The task, as returned by the API.

Schemas: TaskDto

{
  "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"
}

Generated from the schema

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.

Attributes

idstring

Unique task identifier.

titlestring

Task title.

descriptionstring | null

Task description or notes; null if it has none.

startDatestring<date-time>

Start date and time in ISO 8601 with offset.

endDatestring<date-time> | null

End date and time in ISO 8601 with offset; null if it has no defined end.

isAllDayboolean

Whether the task is all-day.

isCompletedboolean

Whether the task is completed.

isRecurringboolean

Whether the task is part of a recurring series.

recurringGroupIdstring | null

Identifier of the recurrence group it belongs to; null if it is not recurring.

recurrencePatternobject | null

Recurrence pattern of the task; null if it is not recurring.

Show child attributes

recurrencePattern.frequencystring

Recurrence frequency: daily, weekly, monthly or yearly.

Available options: daily, weekly, monthly, yearly

recurrencePattern.intervalinteger

Interval between repetitions according to the frequency (e.g. 2 with weekly = every two weeks).

recurrencePattern.endAfterOccurrencesinteger | null

Number of repetitions after which the recurrence ends; null if it does not end by number of occurrences.

recurrencePattern.endDatestring<date-time> | null

Date on which the recurrence ends, in ISO 8601 with offset; null if it does not end by date.

typestring

Task type (identifier of the type).

assignedStaffIdsstring[]

Identifiers of the staff assigned to the task.

projectIdstring | null

Identifier of the linked project; null if the task is not linked.

relatedDocumentIdstring | null

Identifier of the related document; null if it has none.

relatedDocumentTypestring | null

Type of the related document (contact, order, invoice, quote, project, etc.); null if it has none.

appearanceobject

Appearance of the task in the schedule (color and variant).

Show child attributes

appearance.colorstring

Task color in the schedule (hexadecimal code).

appearance.variantstring

Visual variant of the task: primary, secondary, destructive or default.

Available options: primary, secondary, destructive, default

createdAtstring<date-time>

Creation date in ISO 8601 with offset.

updatedAtstring<date-time>

Last update date in ISO 8601 with offset.

Returned by

GET /api/v1/tasks — List tasks
GET /api/v1/tasks/{taskId} — Get a task

Modified by

POST /api/v1/tasks — Create a task
PATCH /api/v1/tasks/{taskId} — Update a task

Was this page helpful?