API Data Provider - Online Help

StoryComments

Returns comments for a specific story.

Columns

Name Type ReadOnly References Description
Id [KEY] Integer True

The unique identifier of the Comment.

AppUrl String True

The URL to the Comment in the Shortcut application.

Text String False

The text content of the Comment, which supports Markdown formatting.

AuthorId String False

Members.Id

The unique identifier (UUID) of the Member who authored the Comment.

ParentId Integer False

The unique identifier of the parent Comment if this is a reply.

Position Integer True

The numeric position of the Comment within the Story's comment thread.

IsDeleted Boolean True

Indicates whether the Comment has been deleted.

IsLinkedToSlack Boolean True

Indicates whether the Comment was posted to or linked with Slack.

EntityType String True

A string description of this resource, always set to 'story-comment'.

MemberMentionIds String True

An array of Member UUIDs who are mentioned in the Comment.

GroupMentionIds String True

An array of Group UUIDs that are mentioned in the Comment.

MentionIds String True

An array of all UUIDs (Members and Groups) mentioned in the Comment.

Reactions String True

An array of reaction objects for emoji reactions on the Comment.

ExternalId String False

A reference identifier from an external system, if integrated.

CreatedAt Datetime False

The timestamp when the Comment was created.

UpdatedAt Datetime False

The timestamp when the Comment was last updated.

StoryId Integer False

Stories.Id

The unique identifier of the Story this comment belongs to.

Copyright (c) 2026 CData Software, Inc. - All rights reserved.
Build 26.0.9770.0