Skip to main content

Get Category's Feed

This endpoint retrieves the category feed.

info

This operation requires authentication only if content_availability community option is false.

HTTP Request

GET /api/v2/category/{id}/feed/

Parameters

NameInTypeRequiredDescription
idpathstringtrueA unique integer value identifying this category
limitqueryintegerfalseNumber of results to return per page
offsetqueryintegerfalseThe initial index from which to return the results
orderingquerystringfalseThe ordering of the feed. Default is based on stream_order_by field in Category object

Enumerated Values

ParameterValueDescription
» orderingrecentOrder by recent creation datetime
» orderinglast_activityOrder by last activity in the Feed object
» orderingrelevanceOrder by relevance algorithm

Example Request

const headers = {
'Accept':'application/json',
'Authorization': 'Bearer {access_token}'
};

fetch('/api/v2/category/{id}/feed/',
{
method: 'GET',

headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});

Responses

StatusMeaningDescriptionSchema
200OKResponse status codeInline

Response Schema

Status Code 200

NameTypeRequiredRestrictionsDescription
» countintegerfalsenoneTotal results count
» nextstring(uri)¦nullfalsenoneNext page url
» previousstring(uri)¦nullfalsenonePrevious page url
» results[Feed]falsenoneList of results

Example responses

{
"count": "integer",
"next": "string(uri)",
"previous": "string(uri)",
"results": [
{
"type": "string",
"post": {
"id": "integer",
"type": "string",
"last_activity_at": "string",
"author": {User},
"added_at": "string",
"last_edited_at": "string",
"html": "string",
"summary": "string",
"deleted": "boolean",
"collapsed": "boolean",
"comment_count": "integer",
"view_count": "integer",
"vote_count": "integer",
"reactions_count": [{Reaction}],
"voted": "boolean",
"reaction": {Reaction},
"follower_count": "integer",
"followed": "boolean",
"suspended": "boolean",
"flag_count": "integer",
"share_count": "integer",
"slug": "string",
"categories": [{Category}],
"medias": [{Media}],
"location": "string",
"addressing": ["integer"],
"tags": ["integer"],
"poll": {Poll}
},
"seen_by_id": ["integer"],
"has_boost": "boolean"
},
]
}