Retrieve insert options

Request

Fetches the list of possible templates which are compatible insert options for a page.

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

insertOptionKindstringrequired

The type of object to retrieve (Page or Folder).

Example:insertOptionKind=Page

environmentIdstring

The identifier of the environment.

Example:environmentId=main

const query = new URLSearchParams({
  site: '3875AC96-8ECF-44AE-8E25-851068B373CE',
  language: 'en-US',
  insertOptionKind: 'Page',
  environmentId: 'main'
}).toString();

const pageId = '8f0b81bc-7388-46be-b109-6e73d1114470';
const resp = await fetch(
  `https://xmapps-api.sitecorecloud.io/api/v1/pages/${pageId}/insertoptions?${query}`,
  {
    method: 'GET',
    headers: {
      Authorization: 'Bearer <YOUR_TOKEN_HERE>'
    }
  }
);

const data = await resp.text();
console.log(data);

Responses

Success

Bodyapplication/json

Array [

idstring or null

Template ID Example value: 6fe7d655-1e3d-4c27-8010-5777f06c6c4f

Example:"6fe7d655-1e3d-4c27-8010-5777f06c6c4f"

displayNamestring or null

Template display name Example value: Page

Example:"Page"

templateTypestring(TemplateType)

The type of template.

Enum:"ItemTemplate""BranchTemplate"

]

Response

[
  {
    "id": "6fe7d655-1e3d-4c27-8010-5777f06c6c4f",
    "displayName": "Page",
    "templateType": "ItemTemplate"
  }
]