posts

Get posts for a channel

Get a page of posts in a channel. Use the query parameters to modify the behaviour of this endpoint. The parameter since must not be used with any of before, after, page, and per_page parameters. If since is used, it will always return all posts modified since that time, ordered by their create time limited till 1000. A caveat with this parameter is that there is no guarantee that the returned posts will be consecutive. It is left to the clients to maintain state and fill any missing holes in the post order.

Permissions

Must have read_channel permission for the channel.

get/api/v4/channels/{channel_id}/posts

Path parameters

channel_idstring required

The channel ID to get the posts for

Query parameters

pageinteger

The page to select

per_pageinteger

The number of posts per page

sinceinteger

Provide a non-zero value in Unix time milliseconds to select posts modified after that time

beforestring

A post id to select the posts that came before this one

afterstring

A post id to select the posts that came after this one

include_deletedboolean

Whether to include deleted posts or not. Must have system admin permissions.

Response

Post list retrieval successful

orderstring[]
postsobject
next_post_idstring

The ID of next post. Not omitted when empty or not relevant.

prev_post_idstring

The ID of previous post. Not omitted when empty or not relevant.

has_nextboolean

Whether there are more items after this page.

Example response

{
  "order": [
    "post_id1",
    "post_id12"
  ]
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.