TimelineEntries REST API endpoint

Disclaimer: This endpoint documentation is generated from the latest Sitevision version. It might differ from the actual Sitevision environment where your website resides.

Use the RestApi utility of the Public API for server-side access of this endpoint.

TimelineEntries

Get, create, update or delete timeline entries.

Applicable to: sv:userIdentity, sv:collaborationGroup, sv:topic.

GET

Returns either a collection of timeline entries or a single entry from a timeline

Requirements

The feature "social collaboration" and that social collaboration is enabled on the sv:site.

Permissions

Retrieving entries from a sv:userIdentity requires that the caller is authorized to READ on the sv:site.
Retrieving entries from a sv:collaborationGroup requires that the caller is allowed to view the group and is authorized to READ the sv:collaborationGroupPage.
Retrieving entries from a sv:topic requires that the caller is a member of the topic.

Retrieving a collection

Returns an array of objects containing timeline entries for a sv:userIdentity or a sv:collaborationGroup.

Parameters

Name	Type	Default	Values	Description	Since
skip	`number`	0	Any positive value	Skips leading number of entries.
limit	`number`	10	1 - 50	Limits the number of entries to return.
offsetEntryId	`string`			From which point to retrieve following entries.	4.5.1
messageFormat	`String`	HTML	HTML, PLAIN, JSON, JSON_TREE, MARKDOWN	The data format for the message in the returned result (JSON since 8, JSON_TREE since 2024.02.1, MARKDOWN since 2024.11.1). Legacy note! MARKDOWN is not applicable for entries stored in the legacy format used prior to 2024.02.1! Using MARKDOWN for such entries will result in the message being returned in HTML format instead.	4.5.2
escapeMessage	`boolean`	false		HTML escape the message (not applicable when messageFormat is PLAIN or MARKDOWN).	7

Example URL

401.95b3be916257bc215c3c0/timelineentries

Example input

{
   "skip": 2,
   "limit": 5,
   "messageFormat": "PLAIN"
}

Example response

[
   {
      "id": "420.95b3be916257bc215c3f6",
      "creationDate": 1521891132679,
      "type": "entry",
      "author": {
         "id": "400.95b3be916257bc215c3ea",
         "fullName": "King of Cool",
         "disabled": true,
         "BuddyIconSize_SMALL": "/images/200.95b3be916257bc215c3f4/1521891117530/deanomartino.jpeg",
         "BuddyIconSize_LARGE": "/images/200.95b3be916257bc215c3f5/1521891117549/deanomartino.jpeg",
         "BuddyIconSize_X_LARGE": "/images/200.95b3be916257bc215c3f6/1521891117560/deanomartino.jpeg"
      },
      "isEditable": true,
      "isRemovable": true,
      "isBookmarkableInGroup": true,
      "isBookmarkable": true,
      "isLikable": true,
      "isSharable": true,
      "isCommentable": true,
      "message": "When the moon hits your eye like a big pizza pie, that's Sitevision",
      "isModified": false,
      "likesCount": 1337,
      "commentsCount": 0,
      "userLikes": true
   },
   {
      "id": "420.95b3be916257bc215c3e8",
      "creationDate": 1521891039503,
      "type": "entry",
      "author": {
         "id": "400.95b3be916257bc215c3d9",
         "fullName": "William H. Rupertus",
         "disabled": false,
         "BuddyIconSize_SMALL": "/images/200.95b3be916257bc215c3e4/1521890985132/fullMetal.jpeg",
         "BuddyIconSize_LARGE": "/images/200.95b3be916257bc215c3e5/1521890997526/fullMetal.jpeg",
         "BuddyIconSize_X_LARGE": "/images/200.95b3be916257bc215c3e6/1521890997565/fullMetal.jpeg"
      },
      "isEditable": true,
      "isRemovable": true,
      "isBookmarkableInGroup": true,
      "isBookmarkable": true,
      "isLikable": true,
      "isSharable": true,
      "isCommentable": true,
      "message": "This is my Sitevision. There are many like it, but this one is mine.",
      "isModified": false,
      "likesCount": 1338,
      "commentsCount": 0,
      "userLikes": true
   }
]

Poll response properties

{
    "id": "420.95b3be916257bc215c3f6",
    "creationDate": 1521891132679,
    "type": "entry",
    "author": {
       "id": "400.95b3be916257bc215c3ea",
       "fullName": "King of Cool",
       "disabled": false,
       "BuddyIconSize_SMALL": "/images/200.95b3be916257bc215c3f4/1521891117530/deanomartino.jpeg",
       "BuddyIconSize_LARGE": "/images/200.95b3be916257bc215c3f5/1521891117549/deanomartino.jpeg",
       "BuddyIconSize_X_LARGE": "/images/200.95b3be916257bc215c3f6/1521891117560/deanomartino.jpeg"
    },
    "isEditable": true,
    "isRemovable": true,
    "isBookmarkableInGroup": true,
    "isBookmarkable": true,
    "isLikable": true,
    "isSharable": true,
    "isCommentable": true,
    "message": "What is your favorite Sitevision feature?",
    "isModified": false,
    "likesCount": 0,
    "commentsCount": 0,
    "userLikes": false,
    "poll": {
       "totalCount": 3,
       "participantsCount": 2,
       "userAlternatives": [
          {
             "id": "420.95b3be916257bc215c410",
             "creator": "400.95b3be916257bc215c3ea",
             "creationDate": 1521891132679,
             "name": "Web publishing"
          }
       ],
       "alternatives": [
          {
             "id": "420.95b3be916257bc215c410",
             "name": "Web publishing",
             "count": 2,
             "voters": []
          },
          {
             "id": "420.95b3be916257bc215c411",
             "name": "Social collaboration",
             "count": 1,
             "voters": []
          }
       ],
       "endDate": 1522495932679,
       "allowPeek": true,
       "showVoters": true,
       "allowMultiChoice": true
    }
 }

An alternative contains a voters array only when poll.showVoters is true. When it is false, the array is omitted while totalCount and participantsCount remain available. (showVoters, voters and participantsCount since 2026.09.1.)

The poll.allowMultiChoice property indicates whether a user may vote for several distinct alternatives. Duplicate votes for the same alternative are never permitted. (allowMultiChoice since 2026.09.1.)

Retrieving a timeline entry

Returns an object containing a specific timeline entry for a sv:userIdentity or a sv:collaborationGroup

Example URL

401.95b3be916257bc215c3c0/timelineentries/420.95b3be916257bc215c3f6

Example response

{
   "id": "420.95b3be916257bc215c3f6",
   "creationDate": 1521891132679,
   "type": "entry",
   "author": {
      "id": "400.95b3be916257bc215c3ea",
      "fullName": "King of Cool",
      "disabled": true,
      "BuddyIconSize_SMALL": "/images/200.95b3be916257bc215c3f4/1521891117530/deanomartino.jpeg",
      "BuddyIconSize_LARGE": "/images/200.95b3be916257bc215c3f5/1521891117549/deanomartino.jpeg",
      "BuddyIconSize_X_LARGE": "/images/200.95b3be916257bc215c3f6/1521891117560/deanomartino.jpeg"
   },
   "isEditable": true,
   "isRemovable": true,
   "isBookmarkableInGroup": true,
   "isBookmarkable": true,
   "isLikable": true,
   "isSharable": true,
   "isCommentable": true,
   "message": "<p>When the moon hits your eye like a big pizza pie, that's Sitevision</p>",
   "isModified": false,
   "likesCount": 1337,
   "commentsCount": 0,
   "userLikes": true
}

POST

Post an entry as the requesting sv:userIdentity.

Returns an object containing the newly created entry.

Requirements

The feature "social collaboration" and that social collaboration is enabled on the sv:site.
The caller must have a sv:userIdentity.

Permissions

Posting to a sv:userIdentity requires that the sv:userIdentity is available and the caller is authorized to READ the sv:site.
Posting to a sv:collaborationGroup requires that the group is active, the caller is allowed to view the group, the caller is authorized to READ the sv:collaborationGroupPage and is authorized to either USE_COLLABORATION_GROUP or MANAGE_COLLABORATION_GROUP.
Posting to a sv:topic requires that the sv:userIdentity is a member of the topic.
Sharing an entry requires regular posting permissions. In addition, the shared entry cannot be a sv:timelineShareEntry, sv:timelineSharePageEntry or belong to a sv:collaborationGroup of type CollaborationGroupType.CLOSED.
Sharing a page requires regular posting permissions. In addition, the caller must be authorized to READ the shared page.

Parameters

Name	Type	Default	Values	Description	Since
message	`string`			The message of the entry (plain text or Markdown-formatted plain text). Mandatory unless sharing an entry or page. The max length of the message is determined by the social collaboration max character count setting (maxEntryCharacterCount property of the sv:site).
poll	`object`			Poll to create. A poll requires a `duration` object and a non-empty `alternatives` array of strings. The optional `allowPeek` property controls whether voters may view the current result before the poll has ended. The optional `showVoters` property controls whether voter identities are included in poll responses. It defaults to `false` and can only be set when the poll is created. (showVoters since 2026.09.1.) The optional boolean `allowMultiChoice` property defaults to `false`. When `false`, each user may select one alternative. When `true`, each user may select several distinct alternatives. Duplicate votes for the same alternative are never permitted. The property can only be set when the poll is created. (allowMultiChoice since 2026.09.1.)	2026.09.1
sharedPageId	`string`			The id of the page to share. Valid page types: sv:page, sv:article, sv:collaborationGroupPage, sv:sitePage
sharedEntryId	`string`			The id of the entry to share. Valid entry types: sv:timelineEntry, sv:timelineFileEntry
messageFormat	`String`	HTML	HTML, PLAIN, JSON, JSON_TREE, MARKDOWN	The data format for the message in the returned result (JSON since 8, JSON_TREE since 2024.02.1, MARKDOWN since 2024.11.1).
escapeMessage	`boolean`	false		HTML escape the message in the returned result (not applicable when messageFormat is PLAIN or MARKDOWN).	7

Example URL

401.95b3be916257bc215c3c0/timelineentries

Example input

{
   "message": "Hello **World!**"
}

Example poll input with hidden voters

{
   "message": "What is your favorite Sitevision feature?",
   "poll": {
      "duration": {
         "days": 7,
         "hours": 0,
         "minutes": 0
      },
      "alternatives": [
         "Web publishing",
         "Social collaboration"
      ],
      "allowPeek": true,
      "showVoters": false,
      "allowMultiChoice": false
   }
}

Example poll input with visible voters

{
   "message": "What is your favorite Sitevision feature?",
   "poll": {
      "duration": {
         "days": 7,
         "hours": 0,
         "minutes": 0
      },
      "alternatives": [
         "Web publishing",
         "Social collaboration"
      ],
      "allowPeek": true,
      "showVoters": true,
      "allowMultiChoice": true
   }
}

Example response

{
   "id": "420.1e37e99816387ceadda8",
   "creationDate": 1527061328783,
   "type": "entry",
   "author": {
      "id": "400.3957727c1634ecea12c2",
      "fullName": "John Doe",
      "disabled": false,
      "BuddyIconSize_SMALL": "/images/200.46523f12163629cf5eb18/1526375100348/john-doe.jpg",
      "BuddyIconSize_LARGE": "/images/200.46523f12163629cf5eb19/1526375100410/john-doe.jpg",
      "BuddyIconSize_X_LARGE": "/images/200.46523f12163629cf5eb20/1526375100451/john-doe.jpg"
   },
   "isEditable": true,
   "isRemovable": true,
   "isBookmarkableInGroup": true,
   "isBookmarkable": true,
   "isLikable": true,
   "isSharable": true,
   "isCommentable": true,
   "message": "<p>Hello <strong>World!</strong></p>",
   "isModified": false,
   "likesCount": 0,
   "commentsCount": 0,
   "userLikes": false
}

PUT

Update an entry as the requesting sv:userIdentity.

Returns an object containing the new message.

Requirements

The feature "social collaboration" and that social collaboration is enabled on the sv:site.
The caller must have a sv:userIdentity.

Permissions

Updating an entry that belongs to a sv:userIdentity requires that the caller is either the author or is authorized to MANAGE_USER_IDENTITIES.
Updating an entry that belongs to a sv:collaborationGroup requires that the caller is authorized to READ the sv:collaborationGroupPage and is either the author or is authorized to MANAGE_COLLABORATION_GROUP.
Updating an entry that belongs to a sv:topic requires that the sv:userIdentity is a member of the topic and is the author.
The caller must have a sv:userIdentity and is authorized to UPDATE the node.

Parameters

Name	Type	Default	Values	Description	Since
message	`string`			The new message of the entry (plain text or Markdown-formatted plain text). The max length of the message is determined by the social collaboration max character count setting (maxEntryCharacterCount property of the sv:site).
poll	`object`			Poll properties to update. The `allowPeek` property controls whether voters may view the current result before the poll has ended. (Updating allowPeek since 2026.09.1.) The `endDate` property sets a new end date as a UNIX timestamp in milliseconds. The `alternatives` property is an array of alternatives to rename. Each item must contain the existing alternative `id` and a new, non-blank `name`. The array may contain a subset of the poll alternatives; alternatives not included are unchanged, and existing alternative IDs are preserved. The `alternativesToAdd` property is a non-empty array of alternative names. The `alternativeIdsToRemove` property is a non-empty array of existing alternative IDs. At least two alternatives must remain after the update. (Alternative updates since 2026.09.1.) Alternatives can only be renamed, added, or removed when every alternative in the poll has zero votes. If any alternative has a vote, or an alternatives payload is invalid, the whole request is rejected without changing any alternative. The `showVoters` property can only be set when the poll is created and cannot be changed with a PUT request. (showVoters since 2026.09.1.) The `allowMultiChoice` property can only be set when the poll is created and cannot be changed with a PUT request. (allowMultiChoice since 2026.09.1.)	2026.09.1
messageFormat	`String`	HTML	HTML, PLAIN, JSON, JSON_TREE, MARKDOWN	The data format for the message in the returned result (JSON since 8, JSON_TREE since 2024.02.1, MARKDOWN since 2024.11.1).
escapeMessage	`boolean`	false		HTML escape the message in the returned result (not applicable when messageFormat is PLAIN or MARKDOWN).	7

Example URL

400.5cd1245216436c70ff91/timelineentries/420.53d6620c1643bceb6e41

Example input

{
   "poll": {
      "allowPeek": true,
       "alternatives": [
          {
             "id": "420.53d6620c1643bceb6e42",
             "name": "A renamed alternative"
          }
       ],
       "alternativesToAdd": [
          "A new alternative"
       ],
       "alternativeIdsToRemove": [
          "420.53d6620c1643bceb6e43"
       ]
   }
}

Example response

{
   "id": "420.53d6620c1643bceb6e41",
   "creationDate": 1527061328783,
   "type": "entry",
   "author": {
      "id": "400.3957727c1634ecea12c2",
      "fullName": "John Doe",
      "disabled": false,
      "BuddyIconSize_SMALL": "/images/200.46523f12163629cf5eb18/1526375100348/john-doe.jpg",
      "BuddyIconSize_LARGE": "/images/200.46523f12163629cf5eb19/1526375100410/john-doe.jpg",
      "BuddyIconSize_X_LARGE": "/images/200.46523f12163629cf5eb20/1526375100451/john-doe.jpg"
   },
   "isEditable": true,
   "isRemovable": true,
   "isBookmarkableInGroup": true,
   "isBookmarkable": true,
   "isLikable": true,
   "isSharable": true,
   "isCommentable": true,
   "message": "<p>Take &amp; <em>break!</em></p>",
   "isModified": false,
   "likesCount": 0,
   "commentsCount": 0,
   "userLikes": false
}

DELETE

Deletes an entry.

Returns an object containing status.

Requirements

The feature "social collaboration" and that social collaboration is enabled on the sv:site.
The caller must have a sv:userIdentity.

Permissions

Deleting an entry that belongs to a sv:userIdentity requires that the caller is either the author or is authorized to MANAGE_USER_IDENTITIES.
Deleting an entry that belongs to a sv:collaborationGroup requires that the caller is authorized to READ the sv:collaborationGroupPage and is either the author or is authorized to MANAGE_COLLABORATION_GROUP.
Deleting an entry that belongs to a sv:topic requires that the sv:userIdentity is a member of the topic and is the author.
The caller must have a sv:userIdentity and is authorized to DELETE the node.

Example URL

400.5cd1245216436c70ff91/timelineentries/420.53d6620c1643bceb6e41

Example response

{
   "success": true
}

Did you find the content on this page useful?

TimelineEntries REST API endpoint