Sitecore API catalog/Pages API/
/
Retrieve a page

Retrieve a page

Request

Fetches information about a page (including statistics, template, layout, publishing and workflow information).

Security
Bearer
Path
pageIdstringrequired

The page identifier.

Example:8f0b81bc-7388-46be-b109-6e73d1114470
Query
sitestringrequired

The site identifier.

Example:site=3875AC96-8ECF-44AE-8E25-851068B373CE
languagestringrequired

The page language.

Example:language=en-US
versioninteger, (int32)

The page version number.

Example:version=2
environmentIdstring

The identifier of the environment.

Example:environmentId=main
curl -i -X GET \
  'https://xmapps-api.sitecorecloud.io/api/v1/pages/8f0b81bc-7388-46be-b109-6e73d1114470?site=3875AC96-8ECF-44AE-8E25-851068B373CE&language=en-US&version=2&environmentId=main' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Success

Bodyapplication/json
urlstring or null

The page URL path. Example value: /about

Example:"/about"
iconstring or null

Path to the icon associated with the page. Example value: Applications/32x32/document_heart.png

Example:"Applications/32x32/document_heart.png"
versionNamestring or null

The name of the page version. Example value: Black Friday content update

Example:"Black Friday content update"
revisionstring or null

The revision of the page. Example value: f7d29433-001e-4a35-a744-876759dba468

Example:"f7d29433-001e-4a35-a744-876759dba468"
createdAtstring or null

The date the page was created. Example value: 2025-01-27T10:33:33Z

Example:"2025-01-27T10:33:33Z"
updatedAtstring or null

The date the page was last updated. Example value: 2025-01-27T10:39:02Z

Example:"2025-01-27T10:39:02Z"
createdBystring or null

The user who created the page. Example value: john.doe@sitecore.com

Example:"john.doe@sitecore.com"
updatedBystring or null

The user who last updated the page. Example value: john.doe@sitecore.com

Example:"john.doe@sitecore.com"
templateobject(PageTemplate)
workflowobject(PageWorkflow)
publishingobject(Publishing)
finalLayoutstring or null

The final layout of the page. Example value: {"devices":[{"id":"fe5d7fdf-89c0-4d99-9aa3-b5fbd009c9f3","layoutId":"96e5f4ba-a2cf-4a4c-a4e7-64da88226362","placeholders":[],"renderings":[{"id":"9c6d53e3-fe57-4638-af7b-6d68304c7a94","instanceId":"ad5e15fb-896b-4415-8735-5e4d6b1543e1","placeholderKey":"headless-main","dataSource":"local:/Data/Text 1","parameters":{"GridParameters":"{7465D855-992E-4DC2-9855-A03250DFA74B}","FieldNames":"{940B57D1-13EA-429D-8C7E-2F6C1307B1B1}","Styles":"","RenderingIdentifier":"","CSSStyles":"","DynamicPlaceholderId":"1"}}]}]}

Example:"{\\\"devices\\\":[{\\\"id\\\":\\\"fe5d7fdf-89c0-4d99-9aa3-b5fbd009c9f3\\\",\\\"layoutId\\\":\\\"96e5f4ba-a2cf-4a4c-a4e7-64da88226362\\\",\\\"placehol
sharedLayoutstring or null

The shared layout of the page. Example value: {"devices":[{"id":"fe5d7fdf-89c0-4d99-9aa3-b5fbd009c9f3","layoutId":"96e5f4ba-a2cf-4a4c-a4e7-64da88226362","placeholders":[],"renderings":[]}]}

Example:"{\\\"devices\\\":[{\\\"id\\\":\\\"fe5d7fdf-89c0-4d99-9aa3-b5fbd009c9f3\\\",\\\"layoutId\\\":\\\"96e5f4ba-a2cf-4a4c-a4e7-64da88226362\\\",\\\"placehol
layoutEditingKindstring or null

The type of layout for editing (Shared of Final). Example value: Final

Example:"Final"
idstring or null

The page identifier. Example value: 68900348a3b84eb8ac7df4d179c25727

Example:"68900348a3b84eb8ac7df4d179c25727"
namestring or null

The page's system name. Example value: Home

Example:"Home"
displayNamestring or null

The page's display name. Example value: Site Home

Example:"Site Home"
languagestring or null

The page language. Example value: en-US

Example:"en-US"
versioninteger, (int32)

The current version of the page. Example value: 1

Example:1
templateIdstring or null

The identifier of the template this page is based on. Example value: 6fe7d6551e3d4c2780105777f06c6c4f

Example:"6fe7d6551e3d4c2780105777f06c6c4f"
parentIdstring or null

The identifier of the page's parent. Example value: 4bc0c81a280b4b13890b7b074b9d68f4

Example:"4bc0c81a280b4b13890b7b074b9d68f4"
hasPresentationboolean

If set to true, this page can be rendered in the XM Cloud Pages application. This value is automatically set to false for the root item of the site, as well as for the folders if there are any. Example value: True

Example:true
hasChildrenboolean

Whether the page has any child pages. Example value: True

Example:true
isLatestPublishableVersionboolean

Whether the page version is latest publishable version Example value: True

Example:true
permissionsobject(Permissions)

The access rights of the current user to the site.

lockingobject(PageLocking)
pathstring or null

The path for the page. Example value: Sitecore/Content/Home/Categories/Products/MyProduct

Example:"Sitecore/Content/Home/Categories/Products/MyProduct"
routestring or null

The public-facing URL path relative to the site's root. Example value: /Aboutus

Example:"/Aboutus"
Response
{
  "url": "/about",
  "icon": "Applications/32x32/document_heart.png",
  "versionName": "Black Friday content update",
  "revision": "f7d29433-001e-4a35-a744-876759dba468",
  "createdAt": "2025-01-27T10:33:33Z",
  "updatedAt": "2025-01-27T10:39:02Z",
  "createdBy": "john.doe@sitecore.com",
  "updatedBy": "john.doe@sitecore.com",
  "template": {
    "id": "2341ef32-42f4-4537-98d8-9ef741008eab",
    "name": "MainPage",
    "path": "/sitecore/templates/Standard Template",
    "baseTemplateIds": [ … ],
    "displayName": "Main Page",
    "isBranchTemplate": true
  },
  "workflow": {
    "id": "77ac7ce9-803a-42e3-bb05-f79fca73cbce",
    "displayName": "Page Workflow",
    "finalState": true,
    "canEdit": true,
    "warnings": [ … ],
    "icon": "Applications/32x32/document_heart.png",
    "commands": [ … ]
  },
  "publishing": {
    "isPublishable": true,
    "hasPublishableVersion": true,
    "isAvailableToPublish": true,
    "validFromDate": "2023-10-01T00:00:00Z",
    "validToDate": "2023-12-31T23:59:59Z"
  },
  "finalLayout": "{\\\"devices\\\":[{\\\"id\\\":\\\"fe5d7fdf-89c0-4d99-9aa3-b5fbd009c9f3\\\",\\\"layoutId\\\":\\\"96e5f4ba-a2cf-4a4c-a4e7-64da88226362\\\",\\\"placeholders\\\":[],\\\"renderings\\\":[{\\\"id\\\":\\\"9c6d53e3-fe57-4638-af7b-6d68304c7a94\\\",\\\"instanceId\\\":\\\"ad5e15fb-896b-4415-8735-5e4d6b1543e1\\\",\\\"placeholderKey\\\":\\\"headless-main\\\",\\\"dataSource\\\":\\\"local:/Data/Text 1\\\",\\\"parameters\\\":{\\\"GridParameters\\\":\\\"{7465D855-992E-4DC2-9855-A03250DFA74B}\\\",\\\"FieldNames\\\":\\\"{940B57D1-13EA-429D-8C7E-2F6C1307B1B1}\\\",\\\"Styles\\\":\\\"\\\",\\\"RenderingIdentifier\\\":\\\"\\\",\\\"CSSStyles\\\":\\\"\\\",\\\"DynamicPlaceholderId\\\":\\\"1\\\"}}]}]}",
  "sharedLayout": "{\\\"devices\\\":[{\\\"id\\\":\\\"fe5d7fdf-89c0-4d99-9aa3-b5fbd009c9f3\\\",\\\"layoutId\\\":\\\"96e5f4ba-a2cf-4a4c-a4e7-64da88226362\\\",\\\"placeholders\\\":[],\\\"renderings\\\":[]}]}",
  "layoutEditingKind": "Final",
  "id": "68900348a3b84eb8ac7df4d179c25727",
  "name": "Home",
  "displayName": "Site Home",
  "language": "en-US",
  "version": 1,
  "templateId": "6fe7d6551e3d4c2780105777f06c6c4f",
  "parentId": "4bc0c81a280b4b13890b7b074b9d68f4",
  "hasPresentation": true,
  "hasChildren": true,
  "isLatestPublishableVersion": true,
  "permissions": {
    "canAdmin": false,
    "canWrite": false,
    "canCreate": false,
    "canDelete": false,
    "canRename": false,
    "canRead": false,
    "canPublish": false,
    "canDuplicate": false,
    "canWriteLanguage": false
  },
  "locking": {
    "canUnlock": false,
    "isLocked": false,
    "lockedBy": "john.smith@skate-park.com",
    "lockedByCurrentUser": false
  },
  "path": "Sitecore/Content/Home/Categories/Products/MyProduct",
  "route": "/Aboutus"
}