Skip to main content
GET
query posts

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

targetId
string

ID of the target.

Maximum string length: 900
targetIds
string[]

IDs of multiple targets to filter by.

Maximum string length: 900
targetType
enum<string>
required

Type of the target.

  • community - Community
  • user - User
  • content - Content
  • all - All
Available options:
community,
user,
content,
all
creatorIds
string[]

Filter posts by their creator user IDs.

Maximum string length: 900
sortBy
enum<string>
default:lastCreated

Sort order for posts.

Available options:
lastCreated,
firstCreated,
lastUpdated,
firstUpdated
hasFlag
boolean

Filter by flag status

isDeleted
boolean

Filter by deleted status

isHidden
boolean

Filter by hidden status. Only honoured for admin callers; ignored otherwise.

feedType
enum<string>

Feed type to filter

Available options:
reviewing,
published,
declined
Example:

"published"

dataTypes
enum<string>[]

Post data type to filter (include child posts too). A custom data type in a.b form is also accepted.

event is accepted on v5 only. As with poll, liveStream and room, the filter matches the child post, so matchingOnlyParentPost=false is required — the parent of an event post has dataType: text. Follow parentPostId to get the parent.

Required array length: 1 - 10 elements
Available options:
text,
video,
image,
file,
liveStream,
poll,
clip,
audio,
room,
event
Maximum string length: 100
tags
string[]

tags

Maximum array length: 5
matchingOnlyParentPost
boolean
default:true

An option to filter only parent post. If true will return only parent post, else will return both parent and child posts

excludeEventDiscussion
boolean

Exclude posts that belong to an event discussion.

includePostedFeed
enum<string>[]

Also include posts from the given feeds.

  • user - posts posted on a user feed
  • community - posts posted on a community feed
Maximum array length: 2
Available options:
user,
community
includeModerationDetails
boolean

Include moderation details in the response.

includeMixedStructure
boolean
default:false

An option to include mixed structure posts (posts that have different data types in parent and child posts)

startDate
string

Admin only. Inclusive start of the createdAt range, as a calendar date (YYYY-MM-DD) interpreted in timeZone. Non-admin callers passing this get a permission error.

Pattern: ^\d{4}-\d{2}-\d{2}$
Example:

"2026-01-31"

endDate
string

Admin only. Inclusive end of the createdAt range, as a calendar date (YYYY-MM-DD) interpreted in timeZone. Non-admin callers passing this get a permission error.

Pattern: ^\d{4}-\d{2}-\d{2}$
Example:

"2026-02-28"

timeZone
string

Admin only. IANA time zone used to resolve startDate / endDate into instants. Defaults to UTC when omitted. Non-admin callers passing this get a permission error.

Example:

"Asia/Bangkok"

useKeySetPagination
boolean
default:true

Use keyset (cursor) pagination instead of skip/limit pagination.

options[limit]
integer
default:10

Page size

Required range: 1 <= x <= 100
Example:

"options[limit]=5"

options[after]
string

Cursor value to get records after

Maximum string length: 24
options[before]
string

Cursor value to get records before

Maximum string length: 24
options[updatedAt]
string

Use updatedAt when sorting by first or last updated

Maximum string length: 30
options[token]
string

Pagination token

Maximum string length: 1000
Example:

"options[token]=eyJza2lwIjoyMCwibGlABDFRffewfQ=="

Response

Post Information

posts
object[]
postChildren
object[]
comments
object[]
users
object[]
files
object[]
communities
object[]
communityUsers
object[]
categories
object[]
feeds
object[]
videoStreamings
object[]
videoStreamingChildren
object[]
rooms
object[]
roomChildrens
object[]
events
object[]

Events referenced by event posts, looked up by postChildren[].data.eventId. A deleted event is absent from this collection — render the card as deleted, the post still exists.

paging
object