v1

latestOpenAPI 3.0.32026-07-13218142597.2 KB
Custom Content

Get custom content by type in page

Returns all custom content for a given type within a given page. The number of results is limited by the limit parameter and additional results (if available) will be available through the next URL present in the Link response header.

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

get/pages/{id}/custom-content

Path parameters

idinteger required

The ID of the page for which custom content should be returned.

Query parameters

typestring required

The type of custom content being requested. See: https://developer.atlassian.com/cloud/confluence/custom-content/ for additional details on custom content.

sort'id' | '-id' | 'created-date' | '-created-date' | 'modified-date' | '-modified-date' | 'title' | '-title'

The sort fields for custom content. The default sort direction is ascending. To sort in descending order, append a - character before the sort field. For example, fieldName or -fieldName.

Used to sort the result by a particular field.

cursorstring

Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results.

limitinteger

Maximum number of pages per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results.

body-format'raw' | 'storage' | 'atlas_doc_format'

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.

Response

Returned if the requested custom content is returned.