timeline.getquerysince 0.1
One timeline: main or a draft, with its parent, versions and status.
Request
umwelt call story.umw timeline.get '{
"projectId": "ball",
"timelineId": "chapter-2"
}'Request
const result = await client.timelineGet({ projectId: 'ball', timelineId: 'chapter-2' });Request
var result = engine.TimelineGet(new TimelineRef { ProjectId = "ball", TimelineId = "chapter-2" });Response
{
"kind": "draft",
"id": "chapter-2",
"status": "active",
"projectId": "ball",
"label": "Chapter 2",
"baseVersion": 14,
"createdAt": "2026-11-11T18:21:58.6687174Z",
"depth": 1,
"headVersion": 15,
"maxTick": 11,
"parentTimelineId": "main"
}Payload
| Field | Type | Description |
|---|---|---|
projectIdrequired | string | The project to read. |
timelineIdrequired | stringdefault "main" | The timeline to read. |
Result
| Field | Type | Description |
|---|---|---|
idalways | string | The timeline’s id. Main is always main. |
projectIdalways | string | The project it belongs to. |
kindalways | "main" | "draft" | main or draft. |
statusalways | "active" | "promoted" | "discarded" | active, promoted or discarded. Only an active timeline accepts writes. |
label | string | Its label. |
parentTimelineId | string | The timeline it branched from: main or another draft. Absent for main. |
depthalways | integer | Drafts from main down to it: 0 for main, 1 for a draft of main, at most 4. |
baseVersion | integer | The parent’s head when it was opened. Absent for main. |
headVersionalways | integer | The version of its latest commit, or its base when it has none. |
maxTickalways | integer | The highest tick it sees. |
createdAtalways | string | When it was opened (UTC). |
closedAt | string | When it was promoted or discarded. |
purgedAt | string | When its rows were purged. |
Errors
VALIDATION_FAILEDThe payload is malformed.NOT_FOUNDThe project or timeline does not exist.HANDSHAKE_REQUIREDOver the protocol, hello was not sent first.Every code is listed in Errors.
See also
Was this page helpful?