Ghost is a fully open source, hackable platform for building and running a modern online publication. We power blogs, magazines and journalists from Zappos to Sky News.
Datatype | Description | Example |
---|---|---|
Datepicker | String which includes date and time | |
Map | String which includes latitude and longitude coma separated | |
List | Simple array | |
Select | String with predefined values | |
Array | Array of objects |
The getAllPosts endpoint allows you to browse all published posts on a particular blog.By default it returns a paginated set of 15 published posts in reverse chronological order (newest first) and excludes pages.
Field | Type | Description |
---|---|---|
clientId | credentials | API client id. |
clientSecret | credentials | API client secret. |
blogUrl | String | Link of the blog on which we will receive data. |
include | Select | Include related data.Options - tags,author,tags and author. |
limit | Number | How many posts to retrieve. |
showAllPosts | Select | Retrieve all posts. |
page | Number | Which page of paginated results to retrieve.The page parameter allows you to specify which page of a paginated collection to return. |
order | String | Choose which field to order by and direction of ordering.You can choose any valid resource field in ascending (asc) or descending (desc) order.Example:id desc. |
fields | List | Allows you to specify which resource fields to retrieve rather than retrieving the. whole object. |
filter | String | Use Ghost Query Language to build complex query.You can combine rules using either ‘and’ or ‘or’. If you’d like to find all posts that are either featured, or they have an image, then you can combine these two rules with a comma , which represents ‘or’: filter=“featured:true,image:-null”. |
resource | String | Id or slug changes query to a read request. |
This endpoint allows you to read a specific post based on its id.
Field | Type | Description |
---|---|---|
clientId | credentials | API client id. |
clientSecret | credentials | API client secret. |
blogUrl | String | Link of the blog on which we will receive data. |
postId | String | Post id you need to get. |
include | Select | Include related data.Options - tags,author,tags and author. |
This endpoint allows you to read a specific post based on its slug.You can then use the parameters to to specify which data to collect. By default it returns a paginated set of 15 tags in order of database row (first row first).
Field | Type | Description |
---|---|---|
clientId | credentials | API client id. |
clientSecret | credentials | API client secret. |
blogUrl | String | Link of the blog on which we will receive data. |
slug | String | Post slug you need to get. |
include | Select | Include related data.Options - tags,author,tags and author. |
The getAllTags endpoints allow you to browse all tags on a particular blog.
Field | Type | Description |
---|---|---|
clientId | credentials | API client id. |
clientSecret | credentials | API client secret. |
blogUrl | String | Link of the blog on which we will receive data. |
includeCountPosts | Select | Include related count posts data.Options - Yes,No. |
limit | Number | How many posts to retrieve. |
showAllPosts | Select | Retrieve all posts on page. |
page | Number | Which page of paginated results to retrieve.The page parameter allows you to specify which page of a paginated collection to return. |
order | String | Choose which field to order by and direction of ordering.You can choose any valid resource field in ascending (asc) or descending (desc) order.Example:id desc. |
fields | List | Allows you to specify which resource fields to retrieve rather than retrieving the. whole object. |
filter | String | Use Ghost Query Language to build complex query.You can combine rules using either ‘and’ or ‘or’. If you’d like to find all posts that are either featured, or they have an image, then you can combine these two rules with a comma , which represents ‘or’: filter=“featured:true,image:-null”. |
resource | String | Id changes query to a read request. |
This endpoint allows you to read a specific tag based on its id.
Field | Type | Description |
---|---|---|
clientId | credentials | API client id. |
clientSecret | credentials | API client secret. |
blogUrl | String | Link of the blog on which we will receive data. |
tagId | String | Tag id you need to get. |
includeCountPosts | Select | Include related count posts data.Options - Yes,No. |
This endpoint allows you to read a specific tag based on its slug.
Field | Type | Description |
---|---|---|
clientId | credentials | API client id. |
clientSecret | credentials | API client secret. |
blogUrl | String | Link of the blog on which we will receive data. |
slug | String | Tag slug you need to get. |
includeCountPosts | Select | Include related count posts data. |
The getAllUsers endpoint allows you to browse all active users on a particular blog.By default it returns a paginated set of 15 active users in descending order of last_login.
Field | Type | Description |
---|---|---|
clientId | credentials | API client id. |
clientSecret | credentials | API client secret. |
blogUrl | String | Link of the blog on which we will receive data. |
includeCountPosts | Select | Include related count posts data. |
limit | Number | How many posts to retrieve. |
showAllPosts | Select | Retrieve all posts on page.Options - Yes,No. |
page | Number | Which page of paginated results to retrieve.The page parameter allows you to specify which page of a paginated collection to return. |
order | String | Choose which field to order by and direction of ordering.You can choose any valid resource field in ascending (asc) or descending (desc) order.Example:id desc. |
fields | List | Allows you to specify which resource fields to retrieve rather than retrieving the. whole object. |
filter | String | Use Ghost Query Language to build complex query.You can combine rules using either ‘and’ or ‘or’. If you’d like to find all posts that are either featured, or they have an image, then you can combine these two rules with a comma , which represents ‘or’: filter=“featured:true,image:-null”. |
This endpoint allows you to read a specific user based on its id.
Field | Type | Description |
---|---|---|
clientId | credentials | API client id. |
clientSecret | credentials | API client secret. |
blogUrl | String | Link of the blog on which we will receive data. |
userId | String | User id you need to get. |
includeCountPosts | Select | Include related count posts data.Options - Yes,No. |
This endpoint allows you to read a specific user based on its slug.
Field | Type | Description |
---|---|---|
clientId | credentials | API client id. |
clientSecret | credentials | API client secret. |
blogUrl | String | Link of the blog on which we will receive data. |
slug | String | User slug you need to get. |
includeCountPosts | Select | Include related count posts data.Options - Yes,No. |
This endpoint allows you to read a specific user based on its email.
Field | Type | Description |
---|---|---|
clientId | credentials | API client id. |
clientSecret | credentials | API client secret. |
blogUrl | String | Link of the blog on which we will receive data. |
String | User email you need to get. | |
includeCountPosts | Select | Include related count posts data. Options - Yes,No. |