Skip to main content

Get a node by path

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

Parameters

NameParameter typeTypeDescriptionExampleRequired
projectIdpathstringThe project identifier found in the project overview screen of the management console.movieDbtrue
nodePathpathstringThe path to the node./en-GB/movies/action/fight-clubtrue
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 truefalse
versionStatusquerystringThe status of the associated entry, either published or latest. The default is publishedfalse
entryFieldsquerystringA comma separated list of entry fields to include in the entry response. Specify * to include all entry fieldsfalse
entryLinkDepthquerynumberThe depth at which to resolve the full entry data for a linked entry or asset, with a maximum depth value of 10false
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){"field1":2,"composer":1,"composer.component.field":2}false
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 existfalse

Responses

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

Examples

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

Still need help?

New support request