Posts

Canonical Thread view

Posts can be viewed in their thread via a short redirect at https://posts.pnut.io/{post_id}.

Post Fields

Field Type Description
bookmarked_by list of objects A sampled list of Users who bookmarked the post.

Only set if query parameter include_bookmarked_by specified.
content object

Not set if the post has been deleted.

Field Type Description
entities object Rich text information for this post. See the Entities documentation.
html string Server-generated annotated HTML rendering of post text.
text string User supplied text of the post. All Unicode characters allowed. Maximum length 256 characters. The maximum length can be retrieved from the Configuration endpoint.
counts object
Field Type Description
bookmarks integer The number of users who have bookmarked this post.
replies integer The number of posts created in reply to this post.
reposts integer The number of users who have reposted this post.
threads integer The number of threads created in reply to this or other children of this post.
created_at string The time at which the post was created in ISO 8601 format; YYYY-MM-DDTHH:MM:SSZ.
id string Primary identifier for a post. This will be an integer, but it is always expressed as a string to avoid limitations with the way JavaScript integers are expressed. This id space is unique to Post objects. There can be a Post and User with the same ID; no relation is implied.
is_deleted boolean Post is deleted. content will not be set.

Only set if true.
is_nsfw boolean User marked the post as "Not Safe For Work".

Only set if true.
is_revised boolean Post has been revised. Looking up the revised posts will return a result.

Only set if true.
raw object The raw items attached to this object.

Only set if query parameter specified.

Field Type Description
{type name} list of objects A list of objects of this type.
reply_to string ID of the post this post is replying to.

Only set if a reply.
repost_of object Embedded post object being reposted.

Only set if a repost of another post.
reposted_by list of objects A sampled list of users who reposted the post.

Only set if query parameter include_bookmarked_by specified.
revision integer Revision number of the post.

Only set if post is a "previous" version of a post. (i.e., from the /posts/{post_id}/revisions endpoint).
source object
Field Type Description
id string The public client ID of the API consumer ("app") that created this post.
name string Description of the API consumer that created this post.
url string Link provided by the API consumer that created this post.
thread_id string The ID of the post at the root of the thread that this post is a part of. If thread_id==id then this property does not guarantee that the thread has > 1 post. Please see replies count.
user object This is an embedded object of the User that created the post.

In certain cases (e.g., when the user account has been deleted), this key may be omitted.
user_id string Primary identifier for the user who created the channel.

Only set if the user above is omitted.
you_bookmarked boolean True if authenticated user bookmarked the post.

Only set on authenticated calls.
you_reposted boolean True if authenticated user reposted the post.

Only set on authenticated calls.

General Post Parameters

Any endpoint that returns post objects can be subject to these parameters.

General Parameters

Name Type Description Default
include_deleted integer (0 or 1) Include deleted posts. true
include_client integer (0 or 1) Include the client object with the post. If false, a source_id field will be included instead. true
include_counts integer (0 or 1) Include the post's counts. Also affects any included user object. true
include_html integer (0 or 1) Should the post and user html field be included alongside the text field in the response objects? true
include_post_html integer (0 or 1) Should the post html field be included alongside the text field in the response objects? true
include_bookmarked_by integer (0 or 1) Include bookmarked_by: a sampled list of users who bookmarked the post. false
include_reposted_by integer (0 or 1) Include reposted_by: a sampled list of users who reposted the post. false
include_directed_posts integer (0 or 1) Include posts with "leading mentions" of users you do not follow. Not applicable to all post streams. true
include_mention_posts integer (0 or 1) Include posts with mentions. true
include_copy_mentions integer (0 or 1) Include "copy mentions" in the /users/{user_id}/mentions endpoint. true
include_replies integer (0 or 1) Include posts replying to other posts. true
include_muted integer (0 or 1) Include posts from users you have muted. false
include_raw integer (0 or 1) Include raw on all objects. false
include_post_raw integer (0 or 1) Include raw on all post objects. false
include_user integer (0 or 1) Include user object. If false, a user_id field will be included instead. true