include
and fields
. Browse endpoints additionally accept filter
, limit
, page
and order
.
The values provided as query parameters MUST be url encoded when used directly. The client libraries will handle this for you.
authors
, tags
count.posts
count.posts
monthly_price
, yearly_price
, benefits
&include=authors,tags
.
For posts and pages:
&include=authors
will add "authors": [{...},]
and "primary_author": {...}
&include=tags
will add "tags": [{...},]
and "primary_tag": {...}
&include=count.posts
will add "count": {"posts": 7}
to the response.&include=monthly_price,yearly_price,benefits
will add monthly price, yearly price, and benefits data.&fields=title,url
would return:
html
is returned, however each post and page in Ghost has 2 available formats: html
and plaintext
.
&formats=html,plaintext
will additionally return the plaintext format.&filter=featured:true
on posts returns only those marked featured.&filter=tag:getting-started
on posts returns those with the tag slug that matches getting-started
.&filter=visibility:public
on tiers returns only those marked as publicly visible.&limit=5
would return only 5 records&limit=100
will return 100 records (max)&page=2
will return the second set of 15 records.published_at DESC
(newest post first)title ASC
(alphabetically by title)name ASC
(alphabetically by name)name ASC
(alphabetically by name)monthly_price ASC
(from lowest to highest monthly price)&order=published_at%20asc
would return posts with the newest post last