Skip to main content

Get a node by path

Log in to add to favourites
GET/api/delivery/projects/{projectId}/nodes/{nodePath}

Parameters

NameParameter typeTypeDescription
projectId(required)pathstringThe project identifier found in the project overview screen of the management console.
nodePath(required)pathstringThe path to the node.
depthquerynumberThe depth of descendants to include for the node. The default is 0. This parameter only has an effect if canonicalOnly has a value of true
versionStatusquerystringThe status of the associated entry, either published or latest. The default is published
entryFieldsquerystringA comma separated list of entry fields to include in the entry response. Specify * to include all entry fields
entryLinkDepthquerynumberThe depth at which to resolve the full entry data for a linked entry or asset, with a maximum depth value of 10
entryFieldLinkDepthsqueryobjectLink depths for specific field paths to resolve the full entry data for a linked entry or asset, with a maximum depth value of 10 (version 16+ only)
allowPartialMatchquerybooleanWhen set to true, returns the nearest ancestor up to, but not including, root on the path if the node at the specified path does not exist

Responses

HTTP status codeReasonModel
200SuccessNode
404Project not foundError
404Node not foundError
500Internal server errorError

Examples

HTTP
GET: /api/delivery/projects/movieDb/nodes/en-GB/movies/action/fight-club?depth=2&versionStatus=latest

Still need help?

If you still need help after reading this article, don't hesitate to reach out to the Contensis community on Slack or raise a support ticket to get help from our team.
New support request