Sign in

v1

latestOpenAPI 3.0.32026-07-13218142597.2 KB
Blog Post

Get blog post by id

Returns a specific blog post.

Permissions required: Permission to view the blog post and its corresponding space.

get/blogposts/{id}

Path parameters

idinteger required

The ID of the blog post to be returned. If you don't know the blog post ID, use Get blog posts and filter the results.

Query parameters

body-format'storage' | 'atlas_doc_format' | 'view' | 'export_view' | 'anonymous_export_view' | 'styled_view' | 'editor'

The primary formats a body can be represented as. A subset of BodyRepresentation. These formats are the only allowed formats in certain use cases.

The content format types to be returned in the body field of the response. If available, the representation will be available under a response field of the same name under the body field.

get-draftboolean

Retrieve the draft version of this blog post.

statusstring[]

Filter the blog post being retrieved by its status.

versioninteger

Allows you to retrieve a previously published version. Specify the previous version's number to retrieve its details.

include-labelsboolean

Includes labels associated with this blog post in the response. The number of results will be limited to 50 and sorted in the default sort order. A meta and _links property will be present to indicate if more results are available and a link to retrieve the rest of the results.

include-propertiesboolean

Includes content properties associated with this blog post in the response. The number of results will be limited to 50 and sorted in the default sort order. A meta and _links property will be present to indicate if more results are available and a link to retrieve the rest of the results.

include-operationsboolean

Includes operations associated with this blog post in the response, as defined in the Operation object. The number of results will be limited to 50 and sorted in the default sort order. A meta and _links property will be present to indicate if more results are available and a link to retrieve the rest of the results.

include-likesboolean

Includes likes associated with this blog post in the response. The number of results will be limited to 50 and sorted in the default sort order. A meta and _links property will be present to indicate if more results are available and a link to retrieve the rest of the results.

include-versionsboolean

Includes versions associated with this blog post in the response. The number of results will be limited to 50 and sorted in the default sort order. A meta and _links property will be present to indicate if more results are available and a link to retrieve the rest of the results.

include-versionboolean

Includes the current version associated with this blog post in the response. By default this is included and can be omitted by setting the value to false.

include-favorited-by-current-user-statusboolean

Includes whether this blog post has been favorited by the current user.

include-webresourcesboolean

Includes web resources that can be used to render blog post content on a client.

include-collaboratorsboolean

Includes collaborators on the blog post.

Response

Returned if the requested blog post is returned.

idstring

ID of the blog post.

status'current' | 'draft' | 'historical' | 'trashed' | 'deleted' | 'any'

The status of the content.

titlestring

Title of the blog post.

spaceIdstring

ID of the space the blog post is in.

authorIdstring

The account ID of the user who created this blog post originally.

createdAtstring date-time

Date and time when the blog post was created. In format "YYYY-MM-DDTHH:mm:ss.sssZ".

isFavoritedByCurrentUserboolean

Whether the blog post has been favorited by the current user.