Skip to main content
Ctrl+K

plone-client

  • Get started
    • Script Plone from Python
    • Manage sites from a terminal
    • Work with assistants and coding agents
  • Tutorials
    • Your first script
    • Your first command line session
    • Your first agent session
    • Build an editorial assistant
    • Migrate content between two sites
  • How-to guides
    • Install plone-client
    • Connect to a site
    • Manage profiles
    • Run a Plone site for testing
    • Sync content from an external source
    • Create content in one step
    • Publish a news item with a lead image
    • Build any block
    • Upload and download files
    • Preview changes and protect a site
    • Handle errors
    • Call other services
    • Work with large sites
    • Manage users and sharing
    • Everyday site management
    • Use the command line in scripts and CI
    • Replace a hand-written client
    • Use plone-client with coding agents
    • Connect an assistant through the MCP server
    • Connect Claude Desktop to a Plone site
    • Protect a site from an agent
    • Build a custom agent
    • Troubleshoot
  • Reference
    • Services
      • Content
      • Search
      • Workflow and history
      • Files
      • Navigation
      • Comments, aliases, relations, and translations
      • Users, groups, and sharing
      • Types and vocabularies
      • Site settings
    • PloneClient
    • Managers
    • Operations
    • Block helpers
    • Content model
    • Other modules
    • Map to @plone/client
    • Command line
    • Cheat sheet
    • MCP server
    • Agent skill
    • Compatibility
    • Configuration
    • Exceptions
    • Changelog
  • Explanation
    • About the design of plone-client
    • About profiles and secrets
    • About the command line for coding agents
    • About the MCP server, the command line, and the skill
    • When to call the API directly
  • Glossary
  • Repository
  • Suggest edit
  • Open issue
  • .md

Navigation

Contents

  • client.navigation
    • client.navigation.navigation
    • client.navigation.breadcrumbs
    • client.navigation.contextnavigation
    • client.navigation.navroot
    • client.navigation.actions
    • client.navigation.inherit

Navigation#

Read the menus and other information that depends on where an item is. None of these calls change the site.

Each example uses the client from How to read these pages.

client.navigation#

NavigationManager.

Contextual information about an item.

client.navigation.navigation#

Top navigation (@navigation).

See navigation().

Calls GET /@navigation (plone.restapi documentation).

client.navigation.navigation(depth=2)
GET /Plone/++api++/@navigation?expand.navigation.depth=2 HTTP/1.1
Host: localhost:8080
Accept: application/json
Authorization: Basic YWRtaW46YWRtaW4=
curl -i -X GET 'http://localhost:8080/Plone/++api++/@navigation?expand.navigation.depth=2' -H 'accept: application/json' -u admin:admin
{
  "@id": "http://localhost:8080/Plone/@navigation",
  "items": [
    {
      "@id": "http://localhost:8080/Plone",
      "title": "Home"
    },
    {
      "@id": "http://localhost:8080/Plone/news",
      "title": "News"
    },
    {
      "@id": "http://localhost:8080/Plone/about",
      "title": "About"
    },
    {
      "@id": "http://localhost:8080/Plone/media",
      "title": "Media"
    }
  ]
}

This shows only @id, items. This shows only @id, title of each entry.

client.navigation.breadcrumbs#

Breadcrumbs of an item (@breadcrumbs).

See breadcrumbs().

Calls GET /news/release-6-2/@breadcrumbs (plone.restapi documentation).

client.navigation.breadcrumbs("/news/release-6-2")
GET /Plone/++api++/news/release-6-2/@breadcrumbs HTTP/1.1
Host: localhost:8080
Accept: application/json
Authorization: Basic YWRtaW46YWRtaW4=
curl -i -X GET http://localhost:8080/Plone/++api++/news/release-6-2/@breadcrumbs -H 'accept: application/json' -u admin:admin
{
  "@id": "http://localhost:8080/Plone/news/release-6-2/@breadcrumbs",
  "items": [
    {
      "@id": "http://localhost:8080/Plone/news",
      "title": "News"
    },
    {
      "@id": "http://localhost:8080/Plone/news/release-6-2",
      "title": "Release 6.2 is out"
    }
  ]
}

This shows only @id, items.

client.navigation.contextnavigation#

Navigation portlet of an item (@contextnavigation).

See contextnavigation().

Calls GET /about/@contextnavigation (plone.restapi documentation).

client.navigation.contextnavigation("/about")
GET /Plone/++api++/about/@contextnavigation HTTP/1.1
Host: localhost:8080
Accept: application/json
Authorization: Basic YWRtaW46YWRtaW4=
curl -i -X GET http://localhost:8080/Plone/++api++/about/@contextnavigation -H 'accept: application/json' -u admin:admin
{
  "available": true,
  "items": [
    {
      "@id": "http://localhost:8080/Plone/about/team",
      "title": "Team"
    }
  ],
  "title": "Navigation"
}

This shows only available, title, items. This shows only @id, title of each entry.

client.navigation.navroot#

Navigation root of an item (@navroot).

See navroot().

Calls GET /news/@navroot (plone.restapi documentation).

client.navigation.navroot("/news")["navroot"]
GET /Plone/++api++/news/@navroot HTTP/1.1
Host: localhost:8080
Accept: application/json
Authorization: Basic YWRtaW46YWRtaW4=
curl -i -X GET http://localhost:8080/Plone/++api++/news/@navroot -H 'accept: application/json' -u admin:admin
{
  "@id": "http://localhost:8080/Plone",
  "title": "Plone Site"
}

This shows only @id, title.

client.navigation.actions#

CMF actions available on an item (@actions).

See actions().

Calls GET /news/@actions (plone.restapi documentation).

client.navigation.actions("/news", categories=["user"])
GET /Plone/++api++/news/@actions?categories%3Alist=user HTTP/1.1
Host: localhost:8080
Accept: application/json
Authorization: Basic YWRtaW46YWRtaW4=
curl -i -X GET 'http://localhost:8080/Plone/++api++/news/@actions?categories%3Alist=user' -H 'accept: application/json' -u admin:admin
{
  "user": [
    {
      "id": "preferences",
      "title": "Preferences"
    },
    {
      "id": "dashboard",
      "title": "Dashboard"
    },
    {
      "id": "plone_setup",
      "title": "Site Setup"
    },
    {
      "id": "logout",
      "title": "Log out"
    }
  ]
}

This shows only user. This shows only id, title of each entry.

client.navigation.inherit#

Field values an item inherits from its parents (@inherit).

See inherit().

Calls GET /news/@inherit (plone.restapi documentation).

client.navigation.inherit("/news", "plone.allowdiscussion")
GET /Plone/++api++/news/@inherit?expand.inherit.behaviors=plone.allowdiscussion HTTP/1.1
Host: localhost:8080
Accept: application/json
Authorization: Basic YWRtaW46YWRtaW4=
curl -i -X GET 'http://localhost:8080/Plone/++api++/news/@inherit?expand.inherit.behaviors=plone.allowdiscussion' -H 'accept: application/json' -u admin:admin
{
  "@id": "http://localhost:8080/Plone/news/@inherit?expand.inherit.behaviors=plone.allowdiscussion",
  "plone.allowdiscussion": {
    "data": {
      "allow_discussion": null
    },
    "from": {
      "@id": "http://localhost:8080/Plone/news",
      "title": "News"
    }
  }
}

This shows only @id, plone.allowdiscussion.

previous

Files

next

Comments, aliases, relations, and translations

Contents
  • client.navigation
    • client.navigation.navigation
    • client.navigation.breadcrumbs
    • client.navigation.contextnavigation
    • client.navigation.navroot
    • client.navigation.actions
    • client.navigation.inherit

By Plone Community

© Copyright 2026.