Skip to main content
GET
Query user feed

Authorizations

Authorization
string
header
required

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

Path Parameters

userId
string
required

ID of the user whose feed is read.

Query Parameters

sortBy
enum<string>
default:lastCreated

Sort order for posts.

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

Filter by deleted status

hasFlag
boolean

Filter by flag status

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
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

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
includeMixedStructure
boolean
default:false

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

options[limit]
integer
default:10

Page size

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

"options[limit]=5"

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