API_POSTS_DOC

Posts A post represents content that a user shares with the community.

JSON format Posts are represented as JSON objects with the following properties:

Name Type Read-only Mandatory Description author_id integer true false The id of the author of the post. *Writable on create by Help Center managers -- see Create Post closed boolean false false Whether further comments are allowed comment_count integer true false The number of comments on the post content_tag_ids array false false The list of content tags attached to the post created_at string true false When the post was created. Writable on create by Help Center managers -- see Create Post details string false false The details of the post made by the author. See User content featured boolean false false Whether the post is featured follower_count integer true false The number of followers of the post html_url string true false The community url of the post id integer true false Automatically assigned when the post is created non_author_editor_id integer true false The user id of whoever performed the most recent (if any) non-author edit. A non-author edit consists of an edit make by a user other than the author that creates or updates the title or details. Note that only edits made after May 17, 2021 will be reflected in this field. If no non-author edits have occured since May 17, 2021, then this field will be null. non_author_updated_at string true false When the post was last edited by a non-author user pinned boolean false false When true, pins the post to the top of its topic status string false false The status of the post. Possible values: "planned", "not_planned" , "answered", or "completed" title string false true The title of the post topic_id integer false false The id of the topic that the post belongs to updated_at string true false When the post was last updated url string true false The API url of the post vote_count integer true false The total number of upvotes and downvotes vote_sum integer true false The sum of upvotes (+1) and downvotes (-1), which may be positive or negative User content End users can add their own contents in the form of community posts, post comments, or article comments. Collectively, this is called user content. The format of user content is HTML-based.

Content may contain the following standard HTML tags:

Paragraphs and blocks: , , , Text formatting: , , , , , , Links and dividers: , Images: (where the src attribute has to reference a user-uploaded image) Headers: , , , , , Bullet lists: , , Description lists: , , Tables: , , , , , , , , Quotes and code snippets: , Semantics: , , , , , , , , , In addition, the content may contain these non-standard HTML tags:

@mentions: , where the contents of the tag should be the user ID of the mentioned user. Example: 1234 to mention the user whose ID is 1234. Even if the content is validated, the body that's output may not be identical to the request body. For example, adjustments may be made for security or standards-compliance reasons.

Example { "author_id": 3465, "featured": true, "id": 1635, "title": "The post" } List Posts GET /api/v2/community/posts GET /api/v2/community/topics/{topic_id}/posts GET /api/v2/community/users/{user_id}/posts Lists all posts, all posts in a given topic, or all posts by a specific user. When listing by specific user, the posts of the user making the request can be listed by specifying me as the id.

Allowed for Anonymous users Pagination Cursor pagination (recommended) Offset pagination See Pagination.

Filtering You can filter the results with the filter_by query string parameter.

GET /api/v2/community/posts.json?filter_by=completed The filter_by parameter can have one of the following values: