Event

A planning event: one block on a user's agenda, optionally linked to a kanban task so time can be logged against it.

Summary view: EventList, 20 fields. What a list returns by default.
Detail view: Event, 23 fields. The default for a single read and for every write.
Read with: api:read:eventsandevents::manage_self
Write with: api:write:eventsandevents::manage_self

Example

detail view

{
  "id": 1,
  "user_id": 1,
  "task_id": 1,
  "parent_event_id": 1,
  "occurrence_date": "2026-03-04",
  "start": "2026-03-03T09:00:00Z",
  "end": "2026-03-03T10:30:00Z",
  "title": "Design review",
  "description": "<p>…</p>",
  "is_all_day": false,
  "is_recurring": false,
  "recurrence_interval": 1,
  "recurrence_frequency": "day",
  "recurrence_pattern": "day_of_month",
  "recurrence_start": "2026-03-04T09:15:00Z",
  "recurrence_end": "2026-03-04T09:15:00Z",
  "selected_weekdays": [
    "monday"
  ],
  "recurrence_exceptions": [
    "2026-03-04"
  ],
  "created_at": "2026-03-04T09:15:00Z",
  "updated_at": "2026-03-04T09:15:00Z",
  "deleted_at": "2026-03-04T09:15:00Z",
  "user": {
    "id": 1
  },
  "links": {
    "self": "https://<your-url>/api/v2/work-items/1"
  }
}

An event is either a one-off or the master of a recurring series, in which case the recurrence fields describe how its occurrences are generated. The occurrences are rendered from those fields and are not rows of their own, except where one was separated in plnnrly.

Used by

GETList events/eventsEventList

POSTCreate an event/eventsEvent

GETRead an event/events/{event}Event

PATCHUpdate an event/events/{event}Event

POSTRestore a deleted event/events/{event}/actions/restoreEvent

Fields

Detail only: Only in the detail view.
Only with include: Only when you ask for it with include.
Server-assigned: Set by plnnrly, never by a request.

idinteger

Unique identifier.

user_idintegerServer-assigned

Whose agenda the event is on. Always the authenticated user at creation time; not writable.

task_idinteger or null

Kanban task this event is planned against, or null for a plain calendar block. Only an event with a task can have time logged on it.

parent_event_idinteger or nullServer-assigned

Master event, when this row is a separated occurrence of a recurring series. Set by the server; not writable.

occurrence_datedate (YYYY-MM-DD) or nullServer-assigned

The date of the series occurrence this row replaces. Set by the server; not writable.

starttimestamp (YYYY-MM-DDThh:mm:ssZ)

When the event starts. RFC 3339 UTC.

endtimestamp (YYYY-MM-DDThh:mm:ssZ)

When the event ends. RFC 3339 UTC.

titlestring≤ 255

Event title, as shown on the calendar tile.

descriptionhtml or nullDetail only

Free-text description, authored in the rich editor. HTML, sanitised on the way in and on the way out; @-mention spans are preserved, and changing them is what notifies the people mentioned.

is_all_dayboolean

Whether the event occupies whole days rather than a time range. An all-day event is measured against the owner's working week rather than against start and end.

Variants

EventList 20 fields

What a collection returns, and what ?view=summary returns on a single record.

Leaves out: description, selected_weekdays, recurrence_exceptions

EventSummary 3 fields

The embedded form: what you get when another resource carries this one and you did not include it.

Leaves out: user_id, task_id, parent_event_id, occurrence_date, end, description, is_all_day, is_recurring, recurrence_interval, recurrence_frequency, recurrence_pattern, recurrence_start, recurrence_end, selected_weekdays, recurrence_exceptions, created_at, updated_at, deleted_at, user, links

EventLinks 1 field

The links object on this resource.

Keys: self

Columns deliberately not published

client_idThe id plnnrly's agenda gives a dropped tile so a repeated create returns the stored event instead of a second one. Only the agenda uses it; an API client neither reads nor sends it.

Something wrong or missing on this page? Tell us