Skip to main content
GET
List articles in a portal

Authorizations

api_access_token
string
header
required

This token can be obtained by visiting the profile page or via rails console. Provides access to endpoints based on the user permissions levels. This token can be saved by an external system when user is created via API, to perform activities on behalf of the user.

Path Parameters

id
string
required

The slug identifier of the portal

Query Parameters

locale
string

Return only articles in this locale.

query
string

Free-text search across title and content.

category_slug
string

Restrict to one category, and order by position rather than by last update.

status
enum<string>

Filter by publication state.

Available options:
draft,
published,
archived
author_id
integer

Restrict to one author.

page
integer

Page number.

Response

Success

payload
object[]

The articles matching the query.

meta
object

Counts for the whole portal, computed before status and author_id are applied — so they do not change as you filter.