Skip to main content

Post

usernamestring
is_first_postboolean
is_last_postboolean
is_unreadboolean

If accessing as a user, true if this post is unread

message_parsedstring

HTML parsed version of the message contents.

can_editboolean
can_soft_deleteboolean
can_hard_deleteboolean
can_reactboolean
can_view_attachmentsboolean
view_urlstring
Thread object

If requested by context, the thread this post is part of.

usernamestring
is_watchingboolean

If accessing as a user, true if they are watching this thread

visitor_post_countinteger

If accessing as a user, the number of posts they have made in this thread

is_unreadboolean

If accessing as a user, true if this thread is unread

custom_fieldsobject

Key-value pairs of custom field values for this thread

tagsundefined[]
prefixstring

Present if this thread has a prefix. Printable name of the prefix.

can_editboolean
can_edit_tagsboolean
can_replyboolean
can_soft_deleteboolean
can_hard_deleteboolean
can_view_attachmentsboolean
view_urlstring
is_first_post_pinnedboolean
highlighted_post_idsundefined[]
is_search_engine_indexableboolean
index_statestring

Present for members with permission to change the search index state of this thread.

Forum object

If requested by context, the forum this thread was posted in.

breadcrumbsundefined[]

A list of breadcrumbs for this node, including the node_id, title, and node_type_id

type_dataobject

Data related to the specific node type this represents. Contents will vary significantly.

view_urlstring
node_idinteger
titlestring
node_namestring
descriptionstring
node_type_idstring
parent_node_idinteger
display_orderinteger
display_in_listboolean
vote_scoreinteger

The content's vote score (if supported)

can_content_voteboolean

True if the viewing user can vote on this content

allowed_content_vote_typesstring[]

List of content vote types allowed on this content

is_content_votedboolean

True if the viewing user has voted on this content

visitor_content_votestring

If the viewer reacted, the vote they case (up/down)

thread_idinteger
node_idinteger
titlestring
reply_countinteger
view_countinteger
user_idinteger
post_dateinteger
stickyboolean
discussion_statestring
discussion_openboolean
discussion_typestring
first_post_idinteger
last_post_dateinteger
last_post_idinteger
last_post_user_idinteger
last_post_usernamestring
first_post_reaction_scoreinteger
prefix_idinteger
featuredboolean
User object

Information about the user. Different information will be included based on permissions and verbosity.

aboutstring
activity_visibleboolean
ageinteger

The user's current age. Only included if available.

alert_optoutundefined[]
allow_post_profilestring
allow_receive_news_feedstring
allow_send_personal_conversationstring
allow_view_identitiesstring
allow_view_profilestring
avatar_urlsobject

Maps from size types to URL.

profile_banner_urlsobject

Maps from size types to URL.

can_banboolean
can_converseboolean
can_editboolean
can_followboolean
can_ignoreboolean
can_post_profileboolean
can_view_profileboolean
can_view_profile_postsboolean
can_warnboolean
content_show_signatureboolean
creation_watch_statestring
custom_fieldsobject

Map of custom field keys and values.

custom_titlestring

Will have a value if a custom title has been specifically set; prefer user_title instead.

dobobject

Date of birth with year, month and day keys.

emailstring
email_on_conversationboolean
gravatarstring
interaction_watch_stateboolean
is_adminboolean
is_bannedboolean
is_discouragedboolean
is_followedboolean

True if the visitor is following this user. Only included if visitor is not a guest.

is_ignoredboolean

True if the visitor is ignoring this user. Only included if visitor is not a guest.

is_moderatorboolean
is_super_adminboolean
last_activityinteger

Unix timestamp of user's last activity, if available.

locationstring
push_on_conversationboolean
push_optoutundefined[]
receive_admin_emailboolean
secondary_group_idsundefined[]
show_dob_dateboolean
show_dob_yearboolean
signaturestring
timezonestring
use_tfaboolean
user_group_idinteger
user_statestring
user_titlestring
visibleboolean
warning_pointsinteger

Current warning points.

websitestring
view_urlstring
user_idinteger
usernamestring
message_countinteger
question_solution_countinteger
register_dateinteger
trophy_pointsinteger
is_staffboolean
reaction_scoreinteger
vote_scoreinteger
Attachments object[]

Attachments to this post, if it has any.

  • Array [
  • filenamestring
    file_sizeinteger
    heightinteger
    widthinteger
    thumbnail_urlstring
    retina_thumbnail_urlstring
    direct_urlstring
    is_videoboolean
    is_audioboolean
    attachment_idinteger
    content_typestring
    content_idinteger
    attach_dateinteger
    view_countinteger
  • ]
  • is_reacted_toboolean

    True if the viewing user has reacted to this content

    visitor_reaction_idinteger

    If the viewer reacted, the ID of the reaction they used

    vote_scoreinteger

    The content's vote score (if supported)

    can_content_voteboolean

    True if the viewing user can vote on this content

    allowed_content_vote_typesstring[]

    List of content vote types allowed on this content

    is_content_votedboolean

    True if the viewing user has voted on this content

    visitor_content_votestring

    If the viewer reacted, the vote they case (up/down)

    post_idinteger
    thread_idinteger
    user_idinteger
    post_dateinteger
    messagestring
    message_statestring
    attach_countinteger
    warning_messagestring
    positioninteger
    last_edit_dateinteger
    reaction_scoreinteger
    User object

    Information about the user. Different information will be included based on permissions and verbosity.

    aboutstring
    activity_visibleboolean
    ageinteger

    The user's current age. Only included if available.

    alert_optoutundefined[]
    allow_post_profilestring
    allow_receive_news_feedstring
    allow_send_personal_conversationstring
    allow_view_identitiesstring
    allow_view_profilestring
    avatar_urlsobject

    Maps from size types to URL.

    profile_banner_urlsobject

    Maps from size types to URL.

    can_banboolean
    can_converseboolean
    can_editboolean
    can_followboolean
    can_ignoreboolean
    can_post_profileboolean
    can_view_profileboolean
    can_view_profile_postsboolean
    can_warnboolean
    content_show_signatureboolean
    creation_watch_statestring
    custom_fieldsobject

    Map of custom field keys and values.

    custom_titlestring

    Will have a value if a custom title has been specifically set; prefer user_title instead.

    dobobject

    Date of birth with year, month and day keys.

    emailstring
    email_on_conversationboolean
    gravatarstring
    interaction_watch_stateboolean
    is_adminboolean
    is_bannedboolean
    is_discouragedboolean
    is_followedboolean

    True if the visitor is following this user. Only included if visitor is not a guest.

    is_ignoredboolean

    True if the visitor is ignoring this user. Only included if visitor is not a guest.

    is_moderatorboolean
    is_super_adminboolean
    last_activityinteger

    Unix timestamp of user's last activity, if available.

    locationstring
    push_on_conversationboolean
    push_optoutundefined[]
    receive_admin_emailboolean
    secondary_group_idsundefined[]
    show_dob_dateboolean
    show_dob_yearboolean
    signaturestring
    timezonestring
    use_tfaboolean
    user_group_idinteger
    user_statestring
    user_titlestring
    visibleboolean
    warning_pointsinteger

    Current warning points.

    websitestring
    view_urlstring
    user_idinteger
    usernamestring
    message_countinteger
    question_solution_countinteger
    register_dateinteger
    trophy_pointsinteger
    is_staffboolean
    reaction_scoreinteger
    vote_scoreinteger
    Post
    {
    "username": "string",
    "is_first_post": true,
    "is_last_post": true,
    "is_unread": true,
    "message_parsed": "string",
    "can_edit": true,
    "can_soft_delete": true,
    "can_hard_delete": true,
    "can_react": true,
    "can_view_attachments": true,
    "view_url": "string",
    "Thread": {
    "username": "string",
    "is_watching": true,
    "visitor_post_count": 0,
    "is_unread": true,
    "custom_fields": {},
    "tags": [
    null
    ],
    "prefix": "string",
    "can_edit": true,
    "can_edit_tags": true,
    "can_reply": true,
    "can_soft_delete": true,
    "can_hard_delete": true,
    "can_view_attachments": true,
    "view_url": "string",
    "is_first_post_pinned": true,
    "highlighted_post_ids": [
    null
    ],
    "is_search_engine_indexable": true,
    "index_state": "string",
    "Forum": {
    "breadcrumbs": [
    null
    ],
    "type_data": {},
    "view_url": "string",
    "node_id": 0,
    "title": "string",
    "node_name": "string",
    "description": "string",
    "node_type_id": "string",
    "parent_node_id": 0,
    "display_order": 0,
    "display_in_list": true
    },
    "vote_score": 0,
    "can_content_vote": true,
    "allowed_content_vote_types": [
    "string"
    ],
    "is_content_voted": true,
    "visitor_content_vote": "string",
    "thread_id": 0,
    "node_id": 0,
    "title": "string",
    "reply_count": 0,
    "view_count": 0,
    "user_id": 0,
    "post_date": 0,
    "sticky": true,
    "discussion_state": "string",
    "discussion_open": true,
    "discussion_type": "string",
    "first_post_id": 0,
    "last_post_date": 0,
    "last_post_id": 0,
    "last_post_user_id": 0,
    "last_post_username": "string",
    "first_post_reaction_score": 0,
    "prefix_id": 0,
    "featured": true,
    "User": {
    "about": "string",
    "activity_visible": true,
    "age": 0,
    "alert_optout": [
    null
    ],
    "allow_post_profile": "string",
    "allow_receive_news_feed": "string",
    "allow_send_personal_conversation": "string",
    "allow_view_identities": "string",
    "allow_view_profile": "string",
    "avatar_urls": {},
    "profile_banner_urls": {},
    "can_ban": true,
    "can_converse": true,
    "can_edit": true,
    "can_follow": true,
    "can_ignore": true,
    "can_post_profile": true,
    "can_view_profile": true,
    "can_view_profile_posts": true,
    "can_warn": true,
    "content_show_signature": true,
    "creation_watch_state": "string",
    "custom_fields": {},
    "custom_title": "string",
    "dob": {},
    "email": "string",
    "email_on_conversation": true,
    "gravatar": "string",
    "interaction_watch_state": true,
    "is_admin": true,
    "is_banned": true,
    "is_discouraged": true,
    "is_followed": true,
    "is_ignored": true,
    "is_moderator": true,
    "is_super_admin": true,
    "last_activity": 0,
    "location": "string",
    "push_on_conversation": true,
    "push_optout": [
    null
    ],
    "receive_admin_email": true,
    "secondary_group_ids": [
    null
    ],
    "show_dob_date": true,
    "show_dob_year": true,
    "signature": "string",
    "timezone": "string",
    "use_tfa": true,
    "user_group_id": 0,
    "user_state": "string",
    "user_title": "string",
    "visible": true,
    "warning_points": 0,
    "website": "string",
    "view_url": "string",
    "user_id": 0,
    "username": "string",
    "message_count": 0,
    "question_solution_count": 0,
    "register_date": 0,
    "trophy_points": 0,
    "is_staff": true,
    "reaction_score": 0,
    "vote_score": 0
    }
    },
    "Attachments": [
    {
    "filename": "string",
    "file_size": 0,
    "height": 0,
    "width": 0,
    "thumbnail_url": "string",
    "retina_thumbnail_url": "string",
    "direct_url": "string",
    "is_video": true,
    "is_audio": true,
    "attachment_id": 0,
    "content_type": "string",
    "content_id": 0,
    "attach_date": 0,
    "view_count": 0
    }
    ],
    "is_reacted_to": true,
    "visitor_reaction_id": 0,
    "vote_score": 0,
    "can_content_vote": true,
    "allowed_content_vote_types": [
    "string"
    ],
    "is_content_voted": true,
    "visitor_content_vote": "string",
    "post_id": 0,
    "thread_id": 0,
    "user_id": 0,
    "post_date": 0,
    "message": "string",
    "message_state": "string",
    "attach_count": 0,
    "warning_message": "string",
    "position": 0,
    "last_edit_date": 0,
    "reaction_score": 0,
    "User": {
    "about": "string",
    "activity_visible": true,
    "age": 0,
    "alert_optout": [
    null
    ],
    "allow_post_profile": "string",
    "allow_receive_news_feed": "string",
    "allow_send_personal_conversation": "string",
    "allow_view_identities": "string",
    "allow_view_profile": "string",
    "avatar_urls": {},
    "profile_banner_urls": {},
    "can_ban": true,
    "can_converse": true,
    "can_edit": true,
    "can_follow": true,
    "can_ignore": true,
    "can_post_profile": true,
    "can_view_profile": true,
    "can_view_profile_posts": true,
    "can_warn": true,
    "content_show_signature": true,
    "creation_watch_state": "string",
    "custom_fields": {},
    "custom_title": "string",
    "dob": {},
    "email": "string",
    "email_on_conversation": true,
    "gravatar": "string",
    "interaction_watch_state": true,
    "is_admin": true,
    "is_banned": true,
    "is_discouraged": true,
    "is_followed": true,
    "is_ignored": true,
    "is_moderator": true,
    "is_super_admin": true,
    "last_activity": 0,
    "location": "string",
    "push_on_conversation": true,
    "push_optout": [
    null
    ],
    "receive_admin_email": true,
    "secondary_group_ids": [
    null
    ],
    "show_dob_date": true,
    "show_dob_year": true,
    "signature": "string",
    "timezone": "string",
    "use_tfa": true,
    "user_group_id": 0,
    "user_state": "string",
    "user_title": "string",
    "visible": true,
    "warning_points": 0,
    "website": "string",
    "view_url": "string",
    "user_id": 0,
    "username": "string",
    "message_count": 0,
    "question_solution_count": 0,
    "register_date": 0,
    "trophy_points": 0,
    "is_staff": true,
    "reaction_score": 0,
    "vote_score": 0
    }
    }