Read an event

GEThttps://<your-url>/api/v2/events/{event}

MCP id events.showAlso on this path: PATCH Update an event, DELETE Delete an event

Returns one event in the detail view, which is where description, selected_weekdays and recurrence_exceptions live; the summary view a list returns omits those three.

Token scope: api:read:events
Without it: 403 insufficient-token-scope.
Permission: events::manage_self
Without it: 403 insufficient-permission.
Rate cost: 1 unit, read bucket.
Also: If-None-Match answers 304 when nothing changed. Never cached: private, no-store. Unknown query parameters are refused, never ignored.

Both are checked, scope first. A token never does more than its user. How access is checked

Request

Example: One event with its owner expanded

curl -G \
  'https://<your-url>/api/v2/events/1' \
  --data-urlencode 'include=user' \
  -H 'Authorization: Bearer <token>' \
  -H 'Accept: application/json'

const response = await fetch('https://<your-url>/api/v2/events/1?include=user', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer <token>',
    'Accept': 'application/json',
  },
});

use Illuminate\Support\Facades\Http;

$response = Http::withToken('<token>')
    ->acceptJson()
    ->get('https://<your-url>/api/v2/events/1?include=user');

import requests
response = requests.request(
    'GET',
    'https://<your-url>/api/v2/events/1?include=user',
    headers={'Authorization': 'Bearer <token>', 'Accept': 'application/json'},
)

Response

The shape of the response, with sample values.

{
  "data": {
    "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
  },
  "meta": {
    "actions": [
      "restore"
    ]
  }
}

11 more fields, listed under Response

user renders as a {"id": N} reference; ?include=user expands it, and that expansion additionally requires users::read and a token scope covering the users prefix. A deleted event is 404 unless you pass trashed=with.

Path parameters

eventintegerRequired

The Event's numeric id. Accepts a soft-deleted record.

Query parameters

Unknown parameters are refused with 400, naming the parameter.

viewstring

Which field set to render.

summarydetaildefault

trashedstring

Whether soft-deleted rows are included.

withoutdefaultwithonly

metaarray of string

Optional meta members to compute for this response.

actions

New values may be added.

Request headers

X-Request-Idstringpattern

A correlation id of your own. It is recorded in our logs next to the server's request id but never returned: the response header always carries the server's id. A value that does not match the pattern is discarded silently, never rejected.

If-None-Matchstring

The ETag a read is conditional on. A match is answered 304 with no body.

Response 200

Returns a Event in the detail view.

Headers

ETag: A strong validator of exactly this representation.
RateLimit: The IETF httpapi-ratelimit-headers form of your remaining allowance on the tightest bucket this request touched.
RateLimit-Policy: The ceiling and window of that bucket, as <limit>;w=<seconds>.
X-Request-Id: The server-generated ULID correlating this response with our logs.

Every response also carries Cache-Control, Vary, X-Content-Type-Options, X-Plnnrly-Api-Version, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset. Headers and versioning

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.

is_recurringboolean

Whether this row is the master of a recurring series. When true, the recurrence fields describe how occurrences are generated.

recurrence_intervalinteger or null

How many frequency units pass between occurrences: 2 with a weekly frequency is every other week.

recurrence_frequencystring or null

The unit the series repeats in.

dayweekmonthyear

New values may be added.

recurrence_patternstring or null

How a monthly or yearly series positions its occurrence within the month. Ignored for a daily or weekly frequency.

day_of_monthweekday_occurrence

New values may be added.

recurrence_starttimestamp (YYYY-MM-DDThh:mm:ssZ) or null

First moment the series may generate an occurrence.

recurrence_endtimestamp (YYYY-MM-DDThh:mm:ssZ) or null

Last moment the series may generate an occurrence; null for an open-ended series.

selected_weekdaysarray of string or nullDetail only

Weekdays a recurring event falls on. Applies to a weekly frequency; ignored otherwise.

monday
tuesday
wednesday
thursday
friday
saturday
sunday

New values may be added.

recurrence_exceptionsarray of string or nullDetail only

Dates on which this recurrence does not occur. plnnrly adds one whenever a single occurrence is separated or deleted.

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

Creation timestamp.

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

Last-write timestamp; use for incremental sync.

deleted_attimestamp (YYYY-MM-DDThh:mm:ssZ) or null

When the event was deleted, or null while it is live. Reach a deleted event with trashed=with and undo it with POST events/{event}/actions/restore.