List posts

get

https://api.fanheroapi.com/posts

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Overview

Returns a paginated list all posts hosted on a channel.

Request

To specify the channel, provide the channel ID in the channel header parameter.

To filter the posts, use the type, statis, isAvatar, and file query parameters.

Header parameters organization is required for authentication.

Query Params

pageSize

number

Number of documents that will be returned

page

number

Page to search. Numbering starts with 0.

sortBy

string

The sort-by field name and order. Format: <field_name>.<asc|desc> (asc for ascending and desc for descending order). If no order is specified, descending order is used.

featured

boolean

If True, return only featured posts

category

string

Filter by category

publishedAt

date-time

Filter by publication date

type

string

enum

Return posts of a specific type

Allowed:

typeIn

array of strings

Use several post types in the filter

typeIn

Allowed:

typeNot

string

enum

Exclude posts of this type

Allowed:

typeNotIn

array of strings

Exclude posts of these types

typeNotIn

Allowed:

Headers

channel

string

required

Channel ID

organization

string

required

The URL of the end-user web application

Response

200

Successful response

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here!