Sign in

v1

latestOpenAPI 3.0.32026-07-13218142597.2 KB
Smart Link

Get Smart Link in the content tree by id

Returns a specific Smart Link in the content tree.

Permissions required: Permission to view the Smart Link in the content tree and its corresponding space.

get/embeds/{id}

Path parameters

idinteger required

The ID of the Smart Link in the content tree to be returned.

Query parameters

include-collaboratorsboolean

Includes collaborators on the Smart Link.

include-direct-childrenboolean

Includes direct children of the Smart Link, as defined in the ChildrenResponse object.

include-operationsboolean

Includes operations associated with this Smart Link 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-propertiesboolean

Includes content properties associated with this Smart Link 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.

Response

Returned if the requested Smart Link in the content tree is returned.

idstring

ID of the Smart Link in the content tree.

typestring

The content type of the object.

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

The status of the content.

titlestring

Title of the Smart Link in the content tree.

parentIdstring

ID of the parent content, or null if there is no parent content.

parentType'page' | 'whiteboard' | 'database' | 'embed' | 'folder'

Content type of the parent, or null if there is no parent.

positioninteger nullable

Position of the Smart Link within the given parent page tree.

authorIdstring

The account ID of the user who created this Smart Link in the content tree originally.

ownerIdstring

The account ID of the user who owns this Smart Link in the content tree.

createdAtstring date-time

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

embedUrlstring

The embedded URL of the Smart Link. If the Smart Link does not have an embedded URL, this property will not be included in the response.

spaceIdstring

ID of the space the Smart Link is in.