Skip to main content

List posts

Retrieve a paginated list of posts in a community feed.
GET /v1/communities/:community_id/posts
Query parameters:
ParameterTypeDescription
pageintPage number (default: 1).
per_pageintItems per page (max 50).
pinnedboolIf true, return only pinned posts.
author_iduuidFilter posts by a specific author.

Get post

Retrieve a single post by its ID.
GET /v1/communities/:community_id/posts/:id

Create post

Publish a new post to the community feed.
POST /v1/communities/:community_id/posts
Request body:
{
  "content": "<p>Post content in HTML format</p>",
  "media_urls": ["https://..."],
  "is_pinned": false
}
FieldTypeRequiredDescription
contentstringYesPost body in HTML.
media_urlsstring[]NoArray of media attachment URLs.
is_pinnedbooleanNoPin the post to the top of the feed.

Update post

Update the content or properties of an existing post.
PATCH /v1/communities/:community_id/posts/:id
Request body: Any subset of the fields from Create post.

Delete post

Permanently delete a post and all of its comments.
DELETE /v1/communities/:community_id/posts/:id

List comments

Retrieve all comments on a specific post.
GET /v1/communities/:community_id/posts/:post_id/comments
Query parameters:
ParameterTypeDescription
pageintPage number (default: 1).
per_pageintItems per page (max 50).

Create comment

Add a comment to a post. You can create top-level comments or threaded replies.
POST /v1/communities/:community_id/posts/:post_id/comments
Request body:
{
  "content": "Great post!",
  "parent_id": null
}
FieldTypeRequiredDescription
contentstringYesThe comment text.
parent_iduuidNoID of the parent comment for a threaded reply. Use null for a top-level comment.