forked from trheyi/Ghost
-
Notifications
You must be signed in to change notification settings - Fork 0
[WIP] API Documentation
Sebastian Gierlinger edited this page Apr 16, 2014
·
13 revisions
- id: integer
-
uuid: string
Unique identifier generated automatically as UUIDv4. -
title: string
Title of your blog post. -
slug: string
Automatically generated unique slug that is based on the title of your blog post (e.g.: 'Test Post' will become 'test-post'). -
status: string
Possible values aredraftandpublished.statushas influence on who can see your post and if it is shown on the frontpage of your blog. -
markdown: string
Content of your post encoded in markdown. -
image: string
Not used yet. -
featured: boolean
Indicate a featured post. -
page: boolean
Indicate if the post is a page. -
language: string
remark about language format, not used yet, defaults to -
meta_title: string
Not used yet. -
meta_description: string
Not used yet. -
author_id: integer
-
created_at: string
remark about date/time -
created_by: integer, user - includeable
includeable when implemented -
updated_at: string
remark about date/time format -
updated_by: integer, user - includeable
includeable when implemented -
published_at: string
remark about date/time -
published_by: integer, user - includeable
includeable when implemented -
author: object, user
-
tags: array of objects, tags
{
posts: [
{
status: "published",
id: 1,
uuid: "ec630e45-3342-4d7f-a24c-e448263c975b",
title: "Welcome to Ghost",
slug: "welcome-to-ghost",
markdown: "",
image: null,
featured: false,
page: false,
language: "en_US",
meta_title: null,
meta_description: null,
author_id: 1,
created_at: "2014-04-15T12:36:28.353Z",
created_by: 1,
updated_at: "2014-04-15T12:36:28.353Z",
updated_by: 1,
published_at: "2014-04-15T12:36:28.363Z",
published_by: 1,
author: { ... },
tags: [{ ... }]
}
]
}
-
id: required
ID of the post you would like to retrieve. -
status: optional
Possible values aredraft,publishedandall. -
staticPages: optional
Include posts where thepageattribute istrue. Possible values aretrue,falseandall.
| Admin | Editor | Author | NoAuth |
|---|---|---|---|
| read all posts | read all posts | read posts with status published or that were created by the user |
read posts with status `published |
api.posts.read({id: id})GET /ghost/api/v0.1/posts/{id}/