Skip to main content

A post or comment in a forum feed, supporting rich text, attachments, polls, and reactions.

​
id
string
required

Represents a unique identifier that is Base64 obfuscated. It is often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "VXNlci0xMA==") or integer (such as 4) input value will be accepted as an ID.

​
title
string | null
required

The headline of the forum post. Null if the post has no title.

Example:

"Weekly Market Analysis - February 2025"

​
content
string | null
required

The body of the forum post in Markdown format. Null if the post is paywalled and the current user does not have access.

Example:

"## My Strategy\n\nHere are the key steps..."

​
created_at
string<date-time>
required

The time this post was created, as a Unix timestamp.

Example:

"2023-12-01T05:00:00.401Z"

​
updated_at
string<date-time>
required

The time this post was last updated, as a Unix timestamp.

Example:

"2023-12-01T05:00:00.401Z"

​
is_edited
boolean
required

Whether this post has been edited after its initial creation.

​
is_poster_admin
boolean
required

Whether the author of this post is an admin of the company that owns the forum.

​
is_pinned
boolean
required

Whether this post is pinned to the top of the forum feed.

​
parent_id
string | null
required

The unique identifier of the parent post. Null if this is a top-level post.

​
user
object
required

The user who authored this forum post.

​
view_count
integer | null
required

The total number of times this post has been viewed by users.

Example:

42

​
like_count
integer | null
required

The total number of like reactions this post has received.

Example:

42

​
comment_count
integer
required

The total number of direct comments on this post.

Example:

42