Sign in

v1

latestOpenAPI 3.0.32026-07-13218142597.2 KB
Attachment

Get attachment by id

Returns a specific attachment.

Permissions required: Permission to view the attachment's container.

get/attachments/{id}

Path parameters

idstring required

The ID of the attachment to be returned. If you don't know the attachment's ID, use Get attachments for page/blogpost/custom content.

Query parameters

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 attachment 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 attachment 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 attachment 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 attachment 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 attachment in the response. By default this is included and can be omitted by setting the value to false.

include-collaboratorsboolean

Includes collaborators on the attachment.

Response

Returned if the requested attachment is returned.

idstring

ID of the attachment.

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

The status of the content.

titlestring

Title of the comment.

createdAtstring date-time

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

pageIdstring

ID of the containing page.

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

blogPostIdstring

ID of the containing blog post.

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

customContentIdstring

ID of the containing custom content.

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

mediaTypestring

Media Type for the attachment.

mediaTypeDescriptionstring

Media Type description for the attachment.

commentstring

Comment for the attachment.

fileIdstring

File ID of the attachment. This is the ID referenced in atlas_doc_format bodies and is distinct from the attachment ID.

fileSizeinteger

File size of the attachment.

webuiLinkstring

WebUI link of the attachment.

downloadLinkstring

Download link of the attachment.