What is your developer-dependent CMS actually costing you? Calculate your costs and get a full report
What is your developer-dependent CMS actually costing you? Calculate your costs and get a full report
APIs
How the Agility CMS app builds its URLs for content lists, items, pages and page components, and how to find the IDs to link straight to them.
Every content item, page and component in the Agility CMS app has a stable URL. If you know the pattern and the IDs, you can build a link to any of them without opening the app first. This article lists the patterns for content, pages and page components, and shows three ways to find the IDs.
Every URL starts with your instance GUID and a locale code:
https://app.agilitycms.com/instance/{instance-guid}/{locale}/...
{instance-guid} is the ID of your instance, for example abc12345-u.{locale} is a locale code configured on the instance, such as en-us, fr or fr-ca.Both are required. The locale decides which language version of the item opens, so a link built for fr opens the French version.
| What you want to open | Pattern after /{instance-guid}/{locale} |
|---|---|
| A content list | /content/list-{containerID} |
| An item in a content list | /content/list-{containerID}/listitem-{contentID} |
| A single-item container | /content/item-{containerID} |
| A page | /pages/page-{pageID} |
| A component on a page | /pages/page-{pageID}/item-{containerID} |
https://app.agilitycms.com/instance/{instance-guid}/{locale}/content/list-{containerID}/listitem-{contentID}
{containerID} is the ID of the content list (the container), and {contentID} is the ID of the item. These are different numbers. A content model also has its own model ID, which is a third number and does not appear in this URL.
To open just the list, drop the /listitem-{contentID} part.
Some containers hold exactly one item, such as a settings record. These open with item- and the container ID, and no content ID:
https://app.agilitycms.com/instance/{instance-guid}/{locale}/content/item-{containerID}
https://app.agilitycms.com/instance/{instance-guid}/{locale}/pages/page-{pageID}
A component on a page is stored in its own container. The URL nests that container under the page:
https://app.agilitycms.com/instance/{instance-guid}/{locale}/pages/page-{pageID}/item-{containerID}
Here {containerID} is the ID of the component's container, not the component's contentID. Search results and the Management API report both, so check which one you are holding.
Open the item, page or component and read the address bar. The numbers after list-, listitem-, item- and page- are the IDs.
The Agility CMS MCP server can find IDs for you:
search_instance is full-text search across content, components, pages and assets. For content items, pages and components, each hit includes an editUrl that is the finished deep link. It also returns contentID, pageID and containerID where they apply. A number you type also matches IDs exactly.get_containers lists containers. Each one has an ID (the container ID), a modelID, and a modelTypeID.get_sitemap with flat: true returns pageID, pageName and parentPageID for each page.get_content_models and get_component_models list the model IDs.search_instance also returns hits in every locale that has the item, each with its own editUrl. Pass locale to narrow it.
The Content Management API returns contentID for items, pageID for pages and container IDs for containers. The Management SDK for JavaScript wraps those calls. Build the URL yourself from the IDs and your instance GUID using the patterns above.
search_instance and pass on the editUrl.For other screens, such as content models, component models, the media library and the sitemap view, open the screen and copy the address from your browser.