Sign in

v1

latestOpenAPI 3.0.32026-07-13218142597.2 KB
Custom Content

Get custom content by id

Returns a specific piece of custom content.

Permissions required: Permission to view the custom content, the container of the custom content, and the corresponding space (if different from the container).

get/custom-content/{id}

Path parameters

idinteger required

The ID of the custom content to be returned. If you don't know the custom content ID, use Get Custom Content by Type and filter the results.

Query parameters

body-format'raw' | 'storage' | 'atlas_doc_format' | 'view' | 'export_view' | 'anonymous_export_view'

The formats a custom content body can be represented as. A subset of BodyRepresentation.

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.

Note: If the custom content body type is storage, the storage and atlas_doc_format body formats are able to be returned. If the custom content body type is raw, only the raw body format is able to be returned.

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 custom content 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 custom content 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 custom content 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-versionsboolean

Includes versions associated with this custom content 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 custom content in the response. By default this is included and can be omitted by setting the value to false.

include-collaboratorsboolean

Includes collaborators on the custom content.

Response

Returned if the requested custom content is returned.

idstring

ID of the custom content.

typestring

The type of custom content.

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

The status of the content.

titlestring

Title of the custom content.

spaceIdstring

ID of the space the custom content is in.

Note: This is always returned, regardless of if the custom content has a container that is a space.

pageIdstring

ID of the containing page.

Note: This is only returned if the custom content has a container that is a page.

blogPostIdstring

ID of the containing blog post.

Note: This is only returned if the custom content has a container that is a blog post.

customContentIdstring

ID of the containing custom content.

Note: This is only returned if the custom content has a container that is custom content.

authorIdstring

The account ID of the user who created this custom content originally.

createdAtstring date-time

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