RESTful API
Default
Default news World Immunization Week GHO multimedias hubs documents WHOReference emergencies media newsroom ResultsReport IMR-sync

Pages

Get pages

Returns a set of data items of type pages.

Copy GET /api/default/pages
Request Informaion

URI Parameters

None

Body Parameters

None

Request Formats

None.

Response Informaion

Resource Description

Method can return success code: OK - 200 or one of these error codes: BadRequest - 400, NotFound - 404, NotImplemented - 501, InternalServerError - 500, Unauthorized - 401.

Name Description Type Additional Information
LastModified

System.DateTimeOffset

Read only: True
Selected by default: True

UrlName

System.String

Read only: False
Selected by default: True

organizations

System.Guid

Read only: False
Selected by default: False

regionscountries

System.Guid

Read only: False
Selected by default: False

sustainabledevelopmentgoals

System.Guid

Read only: False
Selected by default: False

departmentaltargets

System.Guid

Read only: False
Selected by default: False

healthtopics

System.Guid

Read only: False
Selected by default: False

events

System.Guid

Read only: False
Selected by default: False

publishingoffices

System.Guid

Read only: False
Selected by default: False

WebPageType

System.String

Read only: False
Selected by default: True

targetaudiences

System.Guid

Read only: False
Selected by default: False

OpenGraphTitle

System.String

Read only: False
Selected by default: True

OpenGraphDescription

System.String

Read only: False
Selected by default: True

Title

System.String

Read only: False
Selected by default: True

DateCreated

System.DateTimeOffset

Read only: False
Selected by default: True

ShowInNavigation

System.Boolean

Read only: False
Selected by default: True

ParentId

System.Guid

Read only: False
Selected by default: True

RootId

System.Guid

Read only: False
Selected by default: True

ExpirationInDays

System.Int32

Read only: False
Selected by default: True

HtmlTitle

System.String

Read only: False
Selected by default: False

Description

System.String

Read only: False
Selected by default: False

HeadTagContent

System.String

Read only: False
Selected by default: False

CodeBehindType

System.String

Read only: False
Selected by default: False

IncludeScriptManager

System.Boolean

Read only: False
Selected by default: False

EnableViewState

System.Boolean

Read only: False
Selected by default: False

PageType

Telerik.Sitefinity.Web.Api.Strategies.Pages.PageType

Read only: False
Selected by default: False

RedirectPage

Telerik.Sitefinity.Web.Api.Strategies.Pages.RedirectPage

Read only: False
Selected by default: False

TemplateId

System.Guid

Read only: False
Selected by default: False

RequireSsl

System.Boolean

Read only: False
Selected by default: False

EnableScriptManager

System.Boolean

Read only: False
Selected by default: False

AllowParametersValidation

System.Boolean

Read only: False
Selected by default: False

Crawlable

System.Boolean

Read only: False
Selected by default: False

IncludeInSearchIndex

System.Boolean

Read only: False
Selected by default: False

Priority

System.Single

Read only: False
Selected by default: False

LocalizationStrategy

Telerik.Sitefinity.Localization.LocalizationStrategy

Read only: True
Selected by default: False

CanonicalUrlBehaviour

Telerik.Sitefinity.Web.Api.Strategies.Pages.CanonicalUrlSettings

Read only: False
Selected by default: False

OutputCacheProfile

System.String

Read only: False
Selected by default: False

Renderer

System.String

Read only: False
Selected by default: False

TemplateName

System.String

Read only: False
Selected by default: False

Provider

System.String

Read only: True
Selected by default: True

HasChildren

System.Boolean

Read only: True
Selected by default: True

Breadcrumb

System.String

Read only: True
Selected by default: True

AvailableLanguages

System.String

Read only: True
Selected by default: True

PublicationDate

System.DateTimeOffset

Read only: True
Selected by default: True

ViewUrl

System.String

Read only: True
Selected by default: True

EditUrl

System.String

Read only: True
Selected by default: True

EditUrlBasePath

System.String

Read only: True
Selected by default: True

IsHomePage

System.Boolean

Read only: True
Selected by default: True

RelativeUrlPath

System.String

Read only: True
Selected by default: True

Resource Format

Response Formats
Copy
application/json
[
  {
    "LastModified": "2026-10-17T00:02:56.7771623Z",
    "UrlName": "sample string 2",
    "organizations": "986e9b4f-4e92-47d2-a910-dc00ab0ab84d",
    "regionscountries": "4b729e6a-fcd5-486b-8c6b-cb8b27b6cdfc",
    "sustainabledevelopmentgoals": "6ef8a812-8d65-4145-b6c4-ad16a1e9d8b2",
    "departmentaltargets": "316cc8aa-dee3-4265-86cc-76e02e0d0485",
    "healthtopics": "d452278d-e43f-4d75-b112-4cc30d068a7e",
    "events": "0bf7454c-d7ce-4f39-921a-29bbad98be56",
    "publishingoffices": "28e95fe6-558a-4594-a9e2-a676e8502dab",
    "WebPageType": "sample string 10",
    "targetaudiences": "fbfe0c0a-16a1-4c90-a1c8-ff208751dfec",
    "OpenGraphTitle": "sample string 12",
    "OpenGraphDescription": "sample string 13",
    "Title": "sample string 14",
    "DateCreated": "2026-10-17T00:02:56.7771623Z",
    "ShowInNavigation": true,
    "ParentId": "51a572cf-6517-475c-ac1a-27dae1bd2d43",
    "RootId": "882dc63d-a551-4fcd-ba11-ba4b00b922ac",
    "ExpirationInDays": 19,
    "HtmlTitle": "sample string 20",
    "Description": "sample string 21",
    "HeadTagContent": "sample string 22",
    "CodeBehindType": "sample string 23",
    "IncludeScriptManager": true,
    "EnableViewState": true,
    "PageType": 0,
    "RedirectPage": null,
    "TemplateId": "87952dda-a7f6-4144-9b21-aedadfd402c1",
    "RequireSsl": true,
    "EnableScriptManager": true,
    "AllowParametersValidation": true,
    "Crawlable": true,
    "IncludeInSearchIndex": true,
    "Priority": 32.1,
    "LocalizationStrategy": 0,
    "CanonicalUrlBehaviour": 0,
    "OutputCacheProfile": "sample string 33",
    "Renderer": "sample string 34",
    "TemplateName": "sample string 35",
    "Provider": "sample string 36",
    "HasChildren": true,
    "Breadcrumb": "sample string 38",
    "AvailableLanguages": "sample string 39",
    "PublicationDate": "2026-10-17T00:02:56.7771623Z",
    "ViewUrl": "sample string 41",
    "EditUrl": "sample string 42",
    "EditUrlBasePath": "sample string 43",
    "IsHomePage": true,
    "RelativeUrlPath": "sample string 45"
  },
  {
    "LastModified": "2026-10-17T00:02:56.7771623Z",
    "UrlName": "sample string 2",
    "organizations": "986e9b4f-4e92-47d2-a910-dc00ab0ab84d",
    "regionscountries": "4b729e6a-fcd5-486b-8c6b-cb8b27b6cdfc",
    "sustainabledevelopmentgoals": "6ef8a812-8d65-4145-b6c4-ad16a1e9d8b2",
    "departmentaltargets": "316cc8aa-dee3-4265-86cc-76e02e0d0485",
    "healthtopics": "d452278d-e43f-4d75-b112-4cc30d068a7e",
    "events": "0bf7454c-d7ce-4f39-921a-29bbad98be56",
    "publishingoffices": "28e95fe6-558a-4594-a9e2-a676e8502dab",
    "WebPageType": "sample string 10",
    "targetaudiences": "fbfe0c0a-16a1-4c90-a1c8-ff208751dfec",
    "OpenGraphTitle": "sample string 12",
    "OpenGraphDescription": "sample string 13",
    "Title": "sample string 14",
    "DateCreated": "2026-10-17T00:02:56.7771623Z",
    "ShowInNavigation": true,
    "ParentId": "51a572cf-6517-475c-ac1a-27dae1bd2d43",
    "RootId": "882dc63d-a551-4fcd-ba11-ba4b00b922ac",
    "ExpirationInDays": 19,
    "HtmlTitle": "sample string 20",
    "Description": "sample string 21",
    "HeadTagContent": "sample string 22",
    "CodeBehindType": "sample string 23",
    "IncludeScriptManager": true,
    "EnableViewState": true,
    "PageType": 0,
    "RedirectPage": null,
    "TemplateId": "87952dda-a7f6-4144-9b21-aedadfd402c1",
    "RequireSsl": true,
    "EnableScriptManager": true,
    "AllowParametersValidation": true,
    "Crawlable": true,
    "IncludeInSearchIndex": true,
    "Priority": 32.1,
    "LocalizationStrategy": 0,
    "CanonicalUrlBehaviour": 0,
    "OutputCacheProfile": "sample string 33",
    "Renderer": "sample string 34",
    "TemplateName": "sample string 35",
    "Provider": "sample string 36",
    "HasChildren": true,
    "Breadcrumb": "sample string 38",
    "AvailableLanguages": "sample string 39",
    "PublicationDate": "2026-10-17T00:02:56.7771623Z",
    "ViewUrl": "sample string 41",
    "EditUrl": "sample string 42",
    "EditUrlBasePath": "sample string 43",
    "IsHomePage": true,
    "RelativeUrlPath": "sample string 45"
  }
]

Get pages by key

Gets pages item by id.

Copy GET /api/default/pages({key})
Request Informaion

URI Parameters

Name Description Type Additional Information
key

System.Guid

Required

Body Parameters

None

Request Formats

None.

Response Informaion

Resource Description

Method can return success code: OK - 200 or one of these error codes: BadRequest - 400, NotFound - 404, NotImplemented - 501, InternalServerError - 500, Unauthorized - 401.

Name Description Type Additional Information
LastModified

System.DateTimeOffset

Read only: True
Selected by default: True

UrlName

System.String

Read only: False
Selected by default: True

organizations

System.Guid

Read only: False
Selected by default: False

regionscountries

System.Guid

Read only: False
Selected by default: False

sustainabledevelopmentgoals

System.Guid

Read only: False
Selected by default: False

departmentaltargets

System.Guid

Read only: False
Selected by default: False

healthtopics

System.Guid

Read only: False
Selected by default: False

events

System.Guid

Read only: False
Selected by default: False

publishingoffices

System.Guid

Read only: False
Selected by default: False

WebPageType

System.String

Read only: False
Selected by default: True

targetaudiences

System.Guid

Read only: False
Selected by default: False

OpenGraphTitle

System.String

Read only: False
Selected by default: True

OpenGraphDescription

System.String

Read only: False
Selected by default: True

Title

System.String

Read only: False
Selected by default: True

DateCreated

System.DateTimeOffset

Read only: False
Selected by default: True

ShowInNavigation

System.Boolean

Read only: False
Selected by default: True

ParentId

System.Guid

Read only: False
Selected by default: True

RootId

System.Guid

Read only: False
Selected by default: True

ExpirationInDays

System.Int32

Read only: False
Selected by default: True

HtmlTitle

System.String

Read only: False
Selected by default: False

Description

System.String

Read only: False
Selected by default: False

HeadTagContent

System.String

Read only: False
Selected by default: False

CodeBehindType

System.String

Read only: False
Selected by default: False

IncludeScriptManager

System.Boolean

Read only: False
Selected by default: False

EnableViewState

System.Boolean

Read only: False
Selected by default: False

PageType

Telerik.Sitefinity.Web.Api.Strategies.Pages.PageType

Read only: False
Selected by default: False

RedirectPage

Telerik.Sitefinity.Web.Api.Strategies.Pages.RedirectPage

Read only: False
Selected by default: False

TemplateId

System.Guid

Read only: False
Selected by default: False

RequireSsl

System.Boolean

Read only: False
Selected by default: False

EnableScriptManager

System.Boolean

Read only: False
Selected by default: False

AllowParametersValidation

System.Boolean

Read only: False
Selected by default: False

Crawlable

System.Boolean

Read only: False
Selected by default: False

IncludeInSearchIndex

System.Boolean

Read only: False
Selected by default: False

Priority

System.Single

Read only: False
Selected by default: False

LocalizationStrategy

Telerik.Sitefinity.Localization.LocalizationStrategy

Read only: True
Selected by default: False

CanonicalUrlBehaviour

Telerik.Sitefinity.Web.Api.Strategies.Pages.CanonicalUrlSettings

Read only: False
Selected by default: False

OutputCacheProfile

System.String

Read only: False
Selected by default: False

Renderer

System.String

Read only: False
Selected by default: False

TemplateName

System.String

Read only: False
Selected by default: False

Provider

System.String

Read only: True
Selected by default: True

HasChildren

System.Boolean

Read only: True
Selected by default: True

Breadcrumb

System.String

Read only: True
Selected by default: True

AvailableLanguages

System.String

Read only: True
Selected by default: True

PublicationDate

System.DateTimeOffset

Read only: True
Selected by default: True

ViewUrl

System.String

Read only: True
Selected by default: True

EditUrl

System.String

Read only: True
Selected by default: True

EditUrlBasePath

System.String

Read only: True
Selected by default: True

IsHomePage

System.Boolean

Read only: True
Selected by default: True

RelativeUrlPath

System.String

Read only: True
Selected by default: True

Resource Format

Response Formats
Copy
application/json
{
  "LastModified": "2026-10-17T00:02:56.7771623Z",
  "UrlName": "sample string 2",
  "organizations": "90a7765b-a293-4bab-b38c-f90e1ea65c43",
  "regionscountries": "e8ff11fd-cd15-4304-bd20-ee78a189cdd8",
  "sustainabledevelopmentgoals": "f38d7be1-6ec6-4717-a749-dacf4c6c40e1",
  "departmentaltargets": "c91e4fdd-6faa-4ad4-81c6-d4754f3f86a4",
  "healthtopics": "56e75f55-045b-4c45-9db1-d8cfe4983687",
  "events": "2bb789cf-d1da-4d30-97d6-1a5fa2c6da1c",
  "publishingoffices": "c4a06f00-0537-4beb-bee9-1fb477de8aad",
  "WebPageType": "sample string 10",
  "targetaudiences": "3754ec1b-0cd7-415d-8fd9-ba2e31803c26",
  "OpenGraphTitle": "sample string 12",
  "OpenGraphDescription": "sample string 13",
  "Title": "sample string 14",
  "DateCreated": "2026-10-17T00:02:56.7771623Z",
  "ShowInNavigation": true,
  "ParentId": "89e8fc50-c53e-459f-ad3f-3ee0cd3d0c03",
  "RootId": "820e79bc-4c9f-48d7-98e7-41e2ee71baba",
  "ExpirationInDays": 19,
  "HtmlTitle": "sample string 20",
  "Description": "sample string 21",
  "HeadTagContent": "sample string 22",
  "CodeBehindType": "sample string 23",
  "IncludeScriptManager": true,
  "EnableViewState": true,
  "PageType": 0,
  "RedirectPage": null,
  "TemplateId": "0521456e-a951-4789-99a3-40271baaeb34",
  "RequireSsl": true,
  "EnableScriptManager": true,
  "AllowParametersValidation": true,
  "Crawlable": true,
  "IncludeInSearchIndex": true,
  "Priority": 32.1,
  "LocalizationStrategy": 0,
  "CanonicalUrlBehaviour": 0,
  "OutputCacheProfile": "sample string 33",
  "Renderer": "sample string 34",
  "TemplateName": "sample string 35",
  "Provider": "sample string 36",
  "HasChildren": true,
  "Breadcrumb": "sample string 38",
  "AvailableLanguages": "sample string 39",
  "PublicationDate": "2026-10-17T00:02:56.7771623Z",
  "ViewUrl": "sample string 41",
  "EditUrl": "sample string 42",
  "EditUrlBasePath": "sample string 43",
  "IsHomePage": true,
  "RelativeUrlPath": "sample string 45"
}

Get property

Gets Id property from pages item.

Copy GET /api/default/pages({key})/property
Request Informaion

URI Parameters

Name Description Type Additional Information
key

System.Guid

Required

property

System.String

Required

Body Parameters

None

Request Formats

None.

Response Informaion

Resource Description

Method can return success code: OK - 200 or one of these error codes: BadRequest - 400, NotFound - 404, NotImplemented - 501, InternalServerError - 500, Unauthorized - 401.

Name Description Type Additional Information
Id

System.Guid

Read only: False

Resource Format

Response Formats
Copy
application/json
{
  "Id": "983bad32-aef8-480b-a607-864e2c79122d"
}

Post pages

Creates a pages item.

Copy POST /api/default/pages
Request Informaion

URI Parameters

None

Body Parameters

Name Description Type Additional Information
LastModified

System.DateTimeOffset

Read only: True
Selected by default: True

UrlName

System.String

Read only: False
Selected by default: True

organizations

System.Guid

Read only: False
Selected by default: False

regionscountries

System.Guid

Read only: False
Selected by default: False

sustainabledevelopmentgoals

System.Guid

Read only: False
Selected by default: False

departmentaltargets

System.Guid

Read only: False
Selected by default: False

healthtopics

System.Guid

Read only: False
Selected by default: False

events

System.Guid

Read only: False
Selected by default: False

publishingoffices

System.Guid

Read only: False
Selected by default: False

WebPageType

System.String

Read only: False
Selected by default: True

targetaudiences

System.Guid

Read only: False
Selected by default: False

OpenGraphTitle

System.String

Read only: False
Selected by default: True

OpenGraphDescription

System.String

Read only: False
Selected by default: True

Title

System.String

Read only: False
Selected by default: True

DateCreated

System.DateTimeOffset

Read only: False
Selected by default: True

ShowInNavigation

System.Boolean

Read only: False
Selected by default: True

ParentId

System.Guid

Read only: False
Selected by default: True

RootId

System.Guid

Read only: False
Selected by default: True

ExpirationInDays

System.Int32

Read only: False
Selected by default: True

HtmlTitle

System.String

Read only: False
Selected by default: False

Description

System.String

Read only: False
Selected by default: False

HeadTagContent

System.String

Read only: False
Selected by default: False

CodeBehindType

System.String

Read only: False
Selected by default: False

IncludeScriptManager

System.Boolean

Read only: False
Selected by default: False

EnableViewState

System.Boolean

Read only: False
Selected by default: False

PageType

Telerik.Sitefinity.Web.Api.Strategies.Pages.PageType

Read only: False
Selected by default: False

RedirectPage

Telerik.Sitefinity.Web.Api.Strategies.Pages.RedirectPage

Read only: False
Selected by default: False

TemplateId

System.Guid

Read only: False
Selected by default: False

RequireSsl

System.Boolean

Read only: False
Selected by default: False

EnableScriptManager

System.Boolean

Read only: False
Selected by default: False

AllowParametersValidation

System.Boolean

Read only: False
Selected by default: False

Crawlable

System.Boolean

Read only: False
Selected by default: False

IncludeInSearchIndex

System.Boolean

Read only: False
Selected by default: False

Priority

System.Single

Read only: False
Selected by default: False

LocalizationStrategy

Telerik.Sitefinity.Localization.LocalizationStrategy

Read only: True
Selected by default: False

CanonicalUrlBehaviour

Telerik.Sitefinity.Web.Api.Strategies.Pages.CanonicalUrlSettings

Read only: False
Selected by default: False

OutputCacheProfile

System.String

Read only: False
Selected by default: False

Renderer

System.String

Read only: False
Selected by default: False

TemplateName

System.String

Read only: False
Selected by default: False

Provider

System.String

Read only: True
Selected by default: True

HasChildren

System.Boolean

Read only: True
Selected by default: True

Breadcrumb

System.String

Read only: True
Selected by default: True

AvailableLanguages

System.String

Read only: True
Selected by default: True

PublicationDate

System.DateTimeOffset

Read only: True
Selected by default: True

ViewUrl

System.String

Read only: True
Selected by default: True

EditUrl

System.String

Read only: True
Selected by default: True

EditUrlBasePath

System.String

Read only: True
Selected by default: True

IsHomePage

System.Boolean

Read only: True
Selected by default: True

RelativeUrlPath

System.String

Read only: True
Selected by default: True

Request Formats
Copy
application/json
{
  "UrlName": "sample string 1",
  "organizations": "1c54e1a0-245f-4f79-8b19-0d3c0d087b29",
  "regionscountries": "29ab243e-1227-4f94-872a-2cc8acb70862",
  "sustainabledevelopmentgoals": "ff0287d4-d827-4fe1-8ab5-17d123062975",
  "departmentaltargets": "290243bb-c0a3-47e1-843a-345c72129c5f",
  "healthtopics": "de642fba-8970-4499-830c-5c9317de1aa3",
  "events": "24ba60eb-5799-4dac-b423-836c634b0ca7",
  "publishingoffices": "93413ddb-34e5-4968-b65d-a772e569d46e",
  "WebPageType": "sample string 9",
  "targetaudiences": "49005aeb-bd92-423e-94af-3a137ae962bd",
  "OpenGraphTitle": "sample string 11",
  "OpenGraphDescription": "sample string 12",
  "Title": "sample string 13",
  "DateCreated": "2026-10-17T00:02:56.7771623Z",
  "ShowInNavigation": true,
  "ParentId": "80d83bc4-39dc-4860-8176-6e3c3ca2771c",
  "RootId": "f1aa11be-52b9-4ac9-a948-3fda3e463ad5",
  "ExpirationInDays": 18,
  "HtmlTitle": "sample string 19",
  "Description": "sample string 20",
  "HeadTagContent": "sample string 21",
  "CodeBehindType": "sample string 22",
  "IncludeScriptManager": true,
  "EnableViewState": true,
  "PageType": 0,
  "RedirectPage": null,
  "TemplateId": "0b404ce4-8c38-49cc-8281-d4a94398c4fe",
  "RequireSsl": true,
  "EnableScriptManager": true,
  "AllowParametersValidation": true,
  "Crawlable": true,
  "IncludeInSearchIndex": true,
  "Priority": 31.1,
  "CanonicalUrlBehaviour": 0,
  "OutputCacheProfile": "sample string 32",
  "Renderer": "sample string 33",
  "TemplateName": "sample string 34"
}
Response Informaion

Resource Description

Method can return success code: Created - 201 or one of these error codes: BadRequest - 400, NotFound - 404, NotImplemented - 501, InternalServerError - 500, Unauthorized - 401.

Name Description Type Additional Information
LastModified

System.DateTimeOffset

Read only: True
Selected by default: True

UrlName

System.String

Read only: False
Selected by default: True

organizations

System.Guid

Read only: False
Selected by default: False

regionscountries

System.Guid

Read only: False
Selected by default: False

sustainabledevelopmentgoals

System.Guid

Read only: False
Selected by default: False

departmentaltargets

System.Guid

Read only: False
Selected by default: False

healthtopics

System.Guid

Read only: False
Selected by default: False

events

System.Guid

Read only: False
Selected by default: False

publishingoffices

System.Guid

Read only: False
Selected by default: False

WebPageType

System.String

Read only: False
Selected by default: True

targetaudiences

System.Guid

Read only: False
Selected by default: False

OpenGraphTitle

System.String

Read only: False
Selected by default: True

OpenGraphDescription

System.String

Read only: False
Selected by default: True

Title

System.String

Read only: False
Selected by default: True

DateCreated

System.DateTimeOffset

Read only: False
Selected by default: True

ShowInNavigation

System.Boolean

Read only: False
Selected by default: True

ParentId

System.Guid

Read only: False
Selected by default: True

RootId

System.Guid

Read only: False
Selected by default: True

ExpirationInDays

System.Int32

Read only: False
Selected by default: True

HtmlTitle

System.String

Read only: False
Selected by default: False

Description

System.String

Read only: False
Selected by default: False

HeadTagContent

System.String

Read only: False
Selected by default: False

CodeBehindType

System.String

Read only: False
Selected by default: False

IncludeScriptManager

System.Boolean

Read only: False
Selected by default: False

EnableViewState

System.Boolean

Read only: False
Selected by default: False

PageType

Telerik.Sitefinity.Web.Api.Strategies.Pages.PageType

Read only: False
Selected by default: False

RedirectPage

Telerik.Sitefinity.Web.Api.Strategies.Pages.RedirectPage

Read only: False
Selected by default: False

TemplateId

System.Guid

Read only: False
Selected by default: False

RequireSsl

System.Boolean

Read only: False
Selected by default: False

EnableScriptManager

System.Boolean

Read only: False
Selected by default: False

AllowParametersValidation

System.Boolean

Read only: False
Selected by default: False

Crawlable

System.Boolean

Read only: False
Selected by default: False

IncludeInSearchIndex

System.Boolean

Read only: False
Selected by default: False

Priority

System.Single

Read only: False
Selected by default: False

LocalizationStrategy

Telerik.Sitefinity.Localization.LocalizationStrategy

Read only: True
Selected by default: False

CanonicalUrlBehaviour

Telerik.Sitefinity.Web.Api.Strategies.Pages.CanonicalUrlSettings

Read only: False
Selected by default: False

OutputCacheProfile

System.String

Read only: False
Selected by default: False

Renderer

System.String

Read only: False
Selected by default: False

TemplateName

System.String

Read only: False
Selected by default: False

Provider

System.String

Read only: True
Selected by default: True

HasChildren

System.Boolean

Read only: True
Selected by default: True

Breadcrumb

System.String

Read only: True
Selected by default: True

AvailableLanguages

System.String

Read only: True
Selected by default: True

PublicationDate

System.DateTimeOffset

Read only: True
Selected by default: True

ViewUrl

System.String

Read only: True
Selected by default: True

EditUrl

System.String

Read only: True
Selected by default: True

EditUrlBasePath

System.String

Read only: True
Selected by default: True

IsHomePage

System.Boolean

Read only: True
Selected by default: True

RelativeUrlPath

System.String

Read only: True
Selected by default: True

Resource Format

Response Formats
Copy
application/json
{
  "LastModified": "2026-10-17T00:02:56.7771623Z",
  "UrlName": "sample string 2",
  "organizations": "ca82fb05-0873-4609-b948-ad231aa55c25",
  "regionscountries": "fdd6f191-2bc2-4dc6-bb81-e5010759e7d2",
  "sustainabledevelopmentgoals": "1cdd9913-54c5-441a-9bd1-a707da38a290",
  "departmentaltargets": "b1241d65-e4b6-4e29-b801-79f2108ac8b6",
  "healthtopics": "50d75a7b-5c66-44e8-b003-a2c3e0ab0b01",
  "events": "980977cb-f40a-473a-beaf-4551c3ecb9bb",
  "publishingoffices": "ad4ae8f9-d79c-49aa-9f77-578f866d20d7",
  "WebPageType": "sample string 10",
  "targetaudiences": "298d3b37-2694-4282-a4c5-c238d5aa8a74",
  "OpenGraphTitle": "sample string 12",
  "OpenGraphDescription": "sample string 13",
  "Title": "sample string 14",
  "DateCreated": "2026-10-17T00:02:56.7771623Z",
  "ShowInNavigation": true,
  "ParentId": "79c7238b-b52e-4a0f-9163-4650203e25ed",
  "RootId": "736394f4-c3c6-4686-991f-aec53160f037",
  "ExpirationInDays": 19,
  "HtmlTitle": "sample string 20",
  "Description": "sample string 21",
  "HeadTagContent": "sample string 22",
  "CodeBehindType": "sample string 23",
  "IncludeScriptManager": true,
  "EnableViewState": true,
  "PageType": 0,
  "RedirectPage": null,
  "TemplateId": "c905df11-7b48-49f1-8a8a-196a8659994c",
  "RequireSsl": true,
  "EnableScriptManager": true,
  "AllowParametersValidation": true,
  "Crawlable": true,
  "IncludeInSearchIndex": true,
  "Priority": 32.1,
  "LocalizationStrategy": 0,
  "CanonicalUrlBehaviour": 0,
  "OutputCacheProfile": "sample string 33",
  "Renderer": "sample string 34",
  "TemplateName": "sample string 35",
  "Provider": "sample string 36",
  "HasChildren": true,
  "Breadcrumb": "sample string 38",
  "AvailableLanguages": "sample string 39",
  "PublicationDate": "2026-10-17T00:02:56.7771623Z",
  "ViewUrl": "sample string 41",
  "EditUrl": "sample string 42",
  "EditUrlBasePath": "sample string 43",
  "IsHomePage": true,
  "RelativeUrlPath": "sample string 45"
}

Patch pages by key

Partial update for pages item.

Copy PATCH /api/default/pages({key})
Request Informaion

URI Parameters

Name Description Type Additional Information
key

System.Guid

Required

Body Parameters

Name Description Type Additional Information
LastModified

System.DateTimeOffset

Read only: True
Selected by default: True

UrlName

System.String

Read only: False
Selected by default: True

organizations

System.Guid

Read only: False
Selected by default: False

regionscountries

System.Guid

Read only: False
Selected by default: False

sustainabledevelopmentgoals

System.Guid

Read only: False
Selected by default: False

departmentaltargets

System.Guid

Read only: False
Selected by default: False

healthtopics

System.Guid

Read only: False
Selected by default: False

events

System.Guid

Read only: False
Selected by default: False

publishingoffices

System.Guid

Read only: False
Selected by default: False

WebPageType

System.String

Read only: False
Selected by default: True

targetaudiences

System.Guid

Read only: False
Selected by default: False

OpenGraphTitle

System.String

Read only: False
Selected by default: True

OpenGraphDescription

System.String

Read only: False
Selected by default: True

Title

System.String

Read only: False
Selected by default: True

DateCreated

System.DateTimeOffset

Read only: False
Selected by default: True

ShowInNavigation

System.Boolean

Read only: False
Selected by default: True

ParentId

System.Guid

Read only: False
Selected by default: True

RootId

System.Guid

Read only: False
Selected by default: True

ExpirationInDays

System.Int32

Read only: False
Selected by default: True

HtmlTitle

System.String

Read only: False
Selected by default: False

Description

System.String

Read only: False
Selected by default: False

HeadTagContent

System.String

Read only: False
Selected by default: False

CodeBehindType

System.String

Read only: False
Selected by default: False

IncludeScriptManager

System.Boolean

Read only: False
Selected by default: False

EnableViewState

System.Boolean

Read only: False
Selected by default: False

PageType

Telerik.Sitefinity.Web.Api.Strategies.Pages.PageType

Read only: False
Selected by default: False

RedirectPage

Telerik.Sitefinity.Web.Api.Strategies.Pages.RedirectPage

Read only: False
Selected by default: False

TemplateId

System.Guid

Read only: False
Selected by default: False

RequireSsl

System.Boolean

Read only: False
Selected by default: False

EnableScriptManager

System.Boolean

Read only: False
Selected by default: False

AllowParametersValidation

System.Boolean

Read only: False
Selected by default: False

Crawlable

System.Boolean

Read only: False
Selected by default: False

IncludeInSearchIndex

System.Boolean

Read only: False
Selected by default: False

Priority

System.Single

Read only: False
Selected by default: False

LocalizationStrategy

Telerik.Sitefinity.Localization.LocalizationStrategy

Read only: True
Selected by default: False

CanonicalUrlBehaviour

Telerik.Sitefinity.Web.Api.Strategies.Pages.CanonicalUrlSettings

Read only: False
Selected by default: False

OutputCacheProfile

System.String

Read only: False
Selected by default: False

Renderer

System.String

Read only: False
Selected by default: False

TemplateName

System.String

Read only: False
Selected by default: False

Provider

System.String

Read only: True
Selected by default: True

HasChildren

System.Boolean

Read only: True
Selected by default: True

Breadcrumb

System.String

Read only: True
Selected by default: True

AvailableLanguages

System.String

Read only: True
Selected by default: True

PublicationDate

System.DateTimeOffset

Read only: True
Selected by default: True

ViewUrl

System.String

Read only: True
Selected by default: True

EditUrl

System.String

Read only: True
Selected by default: True

EditUrlBasePath

System.String

Read only: True
Selected by default: True

IsHomePage

System.Boolean

Read only: True
Selected by default: True

RelativeUrlPath

System.String

Read only: True
Selected by default: True

Request Formats
Copy
application/json
{
  "UrlName": "sample string 1",
  "organizations": "0a612d69-596a-440d-b5f4-55077f16cc2a",
  "regionscountries": "14f159c0-cfad-4d6b-a217-6fc69da86815",
  "sustainabledevelopmentgoals": "11a1d25d-82ae-46fd-b5b6-929842b5c6f0",
  "departmentaltargets": "e4136273-f670-4439-92b4-606619809774",
  "healthtopics": "4f19c67a-abda-4ce1-ae11-2b098a7d8cb1",
  "events": "ffb0d181-2a14-491a-8323-8dc19f35aa47",
  "publishingoffices": "56374d66-0802-4daa-87fe-f4a7699f593e",
  "WebPageType": "sample string 9",
  "targetaudiences": "efb5b0b4-e3ad-46c8-ab21-216cda9ea9b5",
  "OpenGraphTitle": "sample string 11",
  "OpenGraphDescription": "sample string 12",
  "Title": "sample string 13",
  "DateCreated": "2026-10-17T00:02:56.7771623Z",
  "ShowInNavigation": true,
  "ParentId": "b14152c7-6525-48f7-b8a9-848503316e49",
  "RootId": "6d566d3e-ee79-463c-99e5-4a4a530ba43d",
  "ExpirationInDays": 18,
  "HtmlTitle": "sample string 19",
  "Description": "sample string 20",
  "HeadTagContent": "sample string 21",
  "CodeBehindType": "sample string 22",
  "IncludeScriptManager": true,
  "EnableViewState": true,
  "PageType": 0,
  "RedirectPage": null,
  "TemplateId": "d682009d-5cb5-40ba-a15a-1c332c6abbc2",
  "RequireSsl": true,
  "EnableScriptManager": true,
  "AllowParametersValidation": true,
  "Crawlable": true,
  "IncludeInSearchIndex": true,
  "Priority": 31.1,
  "CanonicalUrlBehaviour": 0,
  "OutputCacheProfile": "sample string 32",
  "Renderer": "sample string 33",
  "TemplateName": "sample string 34"
}
Response Informaion

Resource Description

Method can return success code: NoContent - 204 or one of these error codes: BadRequest - 400, NotFound - 404, NotImplemented - 501, InternalServerError - 500, Unauthorized - 401.

Resource Format

Response Formats

None.

Put pages by key

Full update for pages item.

Copy PUT /api/default/pages({key})
Request Informaion

URI Parameters

Name Description Type Additional Information
key

System.Guid

Required

Body Parameters

Name Description Type Additional Information
LastModified

System.DateTimeOffset

Read only: True
Selected by default: True

UrlName

System.String

Read only: False
Selected by default: True

organizations

System.Guid

Read only: False
Selected by default: False

regionscountries

System.Guid

Read only: False
Selected by default: False

sustainabledevelopmentgoals

System.Guid

Read only: False
Selected by default: False

departmentaltargets

System.Guid

Read only: False
Selected by default: False

healthtopics

System.Guid

Read only: False
Selected by default: False

events

System.Guid

Read only: False
Selected by default: False

publishingoffices

System.Guid

Read only: False
Selected by default: False

WebPageType

System.String

Read only: False
Selected by default: True

targetaudiences

System.Guid

Read only: False
Selected by default: False

OpenGraphTitle

System.String

Read only: False
Selected by default: True

OpenGraphDescription

System.String

Read only: False
Selected by default: True

Title

System.String

Read only: False
Selected by default: True

DateCreated

System.DateTimeOffset

Read only: False
Selected by default: True

ShowInNavigation

System.Boolean

Read only: False
Selected by default: True

ParentId

System.Guid

Read only: False
Selected by default: True

RootId

System.Guid

Read only: False
Selected by default: True

ExpirationInDays

System.Int32

Read only: False
Selected by default: True

HtmlTitle

System.String

Read only: False
Selected by default: False

Description

System.String

Read only: False
Selected by default: False

HeadTagContent

System.String

Read only: False
Selected by default: False

CodeBehindType

System.String

Read only: False
Selected by default: False

IncludeScriptManager

System.Boolean

Read only: False
Selected by default: False

EnableViewState

System.Boolean

Read only: False
Selected by default: False

PageType

Telerik.Sitefinity.Web.Api.Strategies.Pages.PageType

Read only: False
Selected by default: False

RedirectPage

Telerik.Sitefinity.Web.Api.Strategies.Pages.RedirectPage

Read only: False
Selected by default: False

TemplateId

System.Guid

Read only: False
Selected by default: False

RequireSsl

System.Boolean

Read only: False
Selected by default: False

EnableScriptManager

System.Boolean

Read only: False
Selected by default: False

AllowParametersValidation

System.Boolean

Read only: False
Selected by default: False

Crawlable

System.Boolean

Read only: False
Selected by default: False

IncludeInSearchIndex

System.Boolean

Read only: False
Selected by default: False

Priority

System.Single

Read only: False
Selected by default: False

LocalizationStrategy

Telerik.Sitefinity.Localization.LocalizationStrategy

Read only: True
Selected by default: False

CanonicalUrlBehaviour

Telerik.Sitefinity.Web.Api.Strategies.Pages.CanonicalUrlSettings

Read only: False
Selected by default: False

OutputCacheProfile

System.String

Read only: False
Selected by default: False

Renderer

System.String

Read only: False
Selected by default: False

TemplateName

System.String

Read only: False
Selected by default: False

Provider

System.String

Read only: True
Selected by default: True

HasChildren

System.Boolean

Read only: True
Selected by default: True

Breadcrumb

System.String

Read only: True
Selected by default: True

AvailableLanguages

System.String

Read only: True
Selected by default: True

PublicationDate

System.DateTimeOffset

Read only: True
Selected by default: True

ViewUrl

System.String

Read only: True
Selected by default: True

EditUrl

System.String

Read only: True
Selected by default: True

EditUrlBasePath

System.String

Read only: True
Selected by default: True

IsHomePage

System.Boolean

Read only: True
Selected by default: True

RelativeUrlPath

System.String

Read only: True
Selected by default: True

Request Formats
Copy
application/json
{
  "UrlName": "sample string 1",
  "organizations": "00a060b4-fae9-4741-9ba3-d0408ddfc440",
  "regionscountries": "43907087-98f9-4559-9575-64efbafa5f7d",
  "sustainabledevelopmentgoals": "1939f82d-963a-4aef-b582-8430308714a6",
  "departmentaltargets": "9e2c3253-601e-45ce-9187-4b3019c9a8c6",
  "healthtopics": "e790e660-728c-4f43-bdc5-e3e4a27a4dec",
  "events": "e142e330-0862-4e5d-be13-c36ab808f595",
  "publishingoffices": "78e5864f-a991-4435-86f1-5da8d74ebb56",
  "WebPageType": "sample string 9",
  "targetaudiences": "0a5f0d3a-6aff-4366-9619-acd39b054c8b",
  "OpenGraphTitle": "sample string 11",
  "OpenGraphDescription": "sample string 12",
  "Title": "sample string 13",
  "DateCreated": "2026-10-17T00:02:56.7771623Z",
  "ShowInNavigation": true,
  "ParentId": "0c9d5bf8-c406-456d-bb2d-a07ead9eb14b",
  "RootId": "e21b8823-277b-4ca6-8f81-1e6220701f36",
  "ExpirationInDays": 18,
  "HtmlTitle": "sample string 19",
  "Description": "sample string 20",
  "HeadTagContent": "sample string 21",
  "CodeBehindType": "sample string 22",
  "IncludeScriptManager": true,
  "EnableViewState": true,
  "PageType": 0,
  "RedirectPage": null,
  "TemplateId": "c55b08c4-2f43-43d3-aa3c-c9009b037758",
  "RequireSsl": true,
  "EnableScriptManager": true,
  "AllowParametersValidation": true,
  "Crawlable": true,
  "IncludeInSearchIndex": true,
  "Priority": 31.1,
  "CanonicalUrlBehaviour": 0,
  "OutputCacheProfile": "sample string 32",
  "Renderer": "sample string 33",
  "TemplateName": "sample string 34"
}
Response Informaion

Resource Description

Method can return success code: NoContent - 204 or one of these error codes: BadRequest - 400, NotFound - 404, NotImplemented - 501, InternalServerError - 500, Unauthorized - 401.

Resource Format

Response Formats

None.

Delete pages by key

Deletes a pages item by Id.

Copy DELETE /api/default/pages({key})
Request Informaion

URI Parameters

Name Description Type Additional Information
key

System.Guid

Required

Body Parameters

None

Request Formats

None.

Response Informaion

Resource Description

Method can return success code: NoContent - 204 or one of these error codes: BadRequest - 400, NotFound - 404, NotImplemented - 501, InternalServerError - 500, Unauthorized - 401.

Resource Format

Response Formats

None.

Get OpenGraphImage

Returns a set of related items of type OpenGraphImage from pages item.

Copy GET /api/default/pages({key})/OpenGraphImage
Request Informaion

URI Parameters

Name Description Type Additional Information
key

System.Guid

Required

Body Parameters

None

Request Formats

None.

Response Informaion

Resource Description

Method can return success code: OK - 200 or one of these error codes: BadRequest - 400, NotFound - 404, NotImplemented - 501, InternalServerError - 500, Unauthorized - 401.

Name Description Type Additional Information
LastModified

System.DateTimeOffset

Read only: True
Selected by default: True

PublicationDate

System.DateTimeOffset

Read only: False
Selected by default: True

Title

System.String

Read only: False
Selected by default: True

Description

System.String

Read only: False
Selected by default: True

DateCreated

System.DateTimeOffset

Read only: True
Selected by default: True

IncludeInSitemap

System.Boolean

Read only: False
Selected by default: True

SystemSourceKey

System.String

Read only: False
Selected by default: True

Ordinal

System.Single

Read only: False
Selected by default: True

UrlName

System.String

Read only: False
Selected by default: True

ItemDefaultUrl

System.String

Read only: True
Selected by default: True

Author

System.String

Read only: False
Selected by default: True

Extension

System.String

Read only: True
Selected by default: True

MimeType

System.String

Read only: True
Selected by default: True

TotalSize

System.Int64

Read only: True
Selected by default: True

regionscountries

System.Guid

Read only: False
Selected by default: False

OptImgStatus

System.String

Read only: False
Selected by default: True

publishingoffices

System.Guid

Read only: False
Selected by default: False

events

System.Guid

Read only: False
Selected by default: False

targets

System.Guid

Read only: False
Selected by default: False

Category

System.Guid

Read only: False
Selected by default: False

imagetypes

System.Guid

Read only: False
Selected by default: False

JoomlaArticleId

System.String

Read only: False
Selected by default: True

departmentaltargets

System.Guid

Read only: False
Selected by default: False

IsOptimized

System.Boolean

Read only: False
Selected by default: True

stakeholders

System.Guid

Read only: False
Selected by default: False

Tags

System.Guid

Read only: False
Selected by default: False

healthtopics

System.Guid

Read only: False
Selected by default: False

targetaudiences

System.Guid

Read only: False
Selected by default: False

Width

System.Int32

Read only: True
Selected by default: True

Height

System.Int32

Read only: True
Selected by default: True

AlternativeText

System.String

Read only: False
Selected by default: True

FolderId

System.Guid

Read only: False
Selected by default: True

ParentId

System.Guid

Read only: False
Selected by default: True

Provider

System.String

Read only: True
Selected by default: True

Url

System.String

Read only: True
Selected by default: True

ThumbnailUrl

System.String

Read only: True
Selected by default: True

Thumbnails

Telerik.Sitefinity.Modules.Libraries.Web.Services.Extensibility.ThumbnailModel

Read only: True
Selected by default: False

IsDamMedia

System.Boolean

Read only: True
Selected by default: False

Resource Format

Response Formats
Copy
application/json
[
  {
    "LastModified": "2026-10-17T00:02:56.7771623Z",
    "PublicationDate": "2026-10-17T00:02:56.7771623Z",
    "Title": "sample string 3",
    "Description": "sample string 4",
    "DateCreated": "2026-10-17T00:02:56.7771623Z",
    "IncludeInSitemap": true,
    "SystemSourceKey": "sample string 7",
    "Ordinal": 8.1,
    "UrlName": "sample string 9",
    "ItemDefaultUrl": "sample string 10",
    "Author": "sample string 11",
    "Extension": "sample string 12",
    "MimeType": "sample string 13",
    "TotalSize": 14,
    "regionscountries": "0d18b6f7-6bf1-4a10-bfe2-bf78946667e9",
    "OptImgStatus": "sample string 16",
    "publishingoffices": "f7b60f6e-6413-4af3-84ea-fea317e6d368",
    "events": "ac16631f-8dc4-49ce-b72d-aa1000ea2875",
    "targets": "a29ed9ac-0451-42f9-9b76-2c0ead503207",
    "Category": "61300631-f478-4e66-8337-44516ac11746",
    "imagetypes": "e3846b06-13f9-454d-892c-371678b1c58f",
    "JoomlaArticleId": "sample string 22",
    "departmentaltargets": "1d0ab268-5235-49b3-b33e-e6edff06c492",
    "IsOptimized": true,
    "stakeholders": "4eda1965-2f9f-4c26-8b64-b552eb18760b",
    "Tags": "27a680e7-e037-4b56-bc36-96424538710c",
    "healthtopics": "ee7fafae-9107-4b95-b5a8-58478b74dcfe",
    "targetaudiences": "29e4b81e-35eb-475f-ac83-7cd20c897422",
    "Width": 29,
    "Height": 30,
    "AlternativeText": "sample string 31",
    "FolderId": "bb6470ab-db2a-4191-ae10-bcda82ac6fb2",
    "ParentId": "c55e3bb5-1f22-4169-a2ec-84dc6ac63dae",
    "Provider": "sample string 34",
    "Url": "sample string 35",
    "ThumbnailUrl": "sample string 36",
    "Thumbnails": {
      "Title": "sample string 1",
      "Url": "sample string 2",
      "Width": 3,
      "Height": 4,
      "MimeType": "sample string 5"
    },
    "IsDamMedia": true
  },
  {
    "LastModified": "2026-10-17T00:02:56.7771623Z",
    "PublicationDate": "2026-10-17T00:02:56.7771623Z",
    "Title": "sample string 3",
    "Description": "sample string 4",
    "DateCreated": "2026-10-17T00:02:56.7771623Z",
    "IncludeInSitemap": true,
    "SystemSourceKey": "sample string 7",
    "Ordinal": 8.1,
    "UrlName": "sample string 9",
    "ItemDefaultUrl": "sample string 10",
    "Author": "sample string 11",
    "Extension": "sample string 12",
    "MimeType": "sample string 13",
    "TotalSize": 14,
    "regionscountries": "0d18b6f7-6bf1-4a10-bfe2-bf78946667e9",
    "OptImgStatus": "sample string 16",
    "publishingoffices": "f7b60f6e-6413-4af3-84ea-fea317e6d368",
    "events": "ac16631f-8dc4-49ce-b72d-aa1000ea2875",
    "targets": "a29ed9ac-0451-42f9-9b76-2c0ead503207",
    "Category": "61300631-f478-4e66-8337-44516ac11746",
    "imagetypes": "e3846b06-13f9-454d-892c-371678b1c58f",
    "JoomlaArticleId": "sample string 22",
    "departmentaltargets": "1d0ab268-5235-49b3-b33e-e6edff06c492",
    "IsOptimized": true,
    "stakeholders": "4eda1965-2f9f-4c26-8b64-b552eb18760b",
    "Tags": "27a680e7-e037-4b56-bc36-96424538710c",
    "healthtopics": "ee7fafae-9107-4b95-b5a8-58478b74dcfe",
    "targetaudiences": "29e4b81e-35eb-475f-ac83-7cd20c897422",
    "Width": 29,
    "Height": 30,
    "AlternativeText": "sample string 31",
    "FolderId": "bb6470ab-db2a-4191-ae10-bcda82ac6fb2",
    "ParentId": "c55e3bb5-1f22-4169-a2ec-84dc6ac63dae",
    "Provider": "sample string 34",
    "Url": "sample string 35",
    "ThumbnailUrl": "sample string 36",
    "Thumbnails": {
      "Title": "sample string 1",
      "Url": "sample string 2",
      "Width": 3,
      "Height": 4,
      "MimeType": "sample string 5"
    },
    "IsDamMedia": true
  }
]

Get OpenGraphImage by relatedKey

Returns a related item of type OpenGraphImage from pages item.

Copy GET /api/default/pages({key})/OpenGraphImage({relatedKey})
Request Informaion

URI Parameters

Name Description Type Additional Information
key

System.Guid

Required

relatedKey

System.Guid

Required

Body Parameters

None

Request Formats

None.

Response Informaion

Resource Description

Method can return success code: OK - 200 or one of these error codes: BadRequest - 400, NotFound - 404, NotImplemented - 501, InternalServerError - 500, Unauthorized - 401.

Name Description Type Additional Information
LastModified

System.DateTimeOffset

Read only: True
Selected by default: True

PublicationDate

System.DateTimeOffset

Read only: False
Selected by default: True

Title

System.String

Read only: False
Selected by default: True

Description

System.String

Read only: False
Selected by default: True

DateCreated

System.DateTimeOffset

Read only: True
Selected by default: True

IncludeInSitemap

System.Boolean

Read only: False
Selected by default: True

SystemSourceKey

System.String

Read only: False
Selected by default: True

Ordinal

System.Single

Read only: False
Selected by default: True

UrlName

System.String

Read only: False
Selected by default: True

ItemDefaultUrl

System.String

Read only: True
Selected by default: True

Author

System.String

Read only: False
Selected by default: True

Extension

System.String

Read only: True
Selected by default: True

MimeType

System.String

Read only: True
Selected by default: True

TotalSize

System.Int64

Read only: True
Selected by default: True

regionscountries

System.Guid

Read only: False
Selected by default: False

OptImgStatus

System.String

Read only: False
Selected by default: True

publishingoffices

System.Guid

Read only: False
Selected by default: False

events

System.Guid

Read only: False
Selected by default: False

targets

System.Guid

Read only: False
Selected by default: False

Category

System.Guid

Read only: False
Selected by default: False

imagetypes

System.Guid

Read only: False
Selected by default: False

JoomlaArticleId

System.String

Read only: False
Selected by default: True

departmentaltargets

System.Guid

Read only: False
Selected by default: False

IsOptimized

System.Boolean

Read only: False
Selected by default: True

stakeholders

System.Guid

Read only: False
Selected by default: False

Tags

System.Guid

Read only: False
Selected by default: False

healthtopics

System.Guid

Read only: False
Selected by default: False

targetaudiences

System.Guid

Read only: False
Selected by default: False

Width

System.Int32

Read only: True
Selected by default: True

Height

System.Int32

Read only: True
Selected by default: True

AlternativeText

System.String

Read only: False
Selected by default: True

FolderId

System.Guid

Read only: False
Selected by default: True

ParentId

System.Guid

Read only: False
Selected by default: True

Provider

System.String

Read only: True
Selected by default: True

Url

System.String

Read only: True
Selected by default: True

ThumbnailUrl

System.String

Read only: True
Selected by default: True

Thumbnails

Telerik.Sitefinity.Modules.Libraries.Web.Services.Extensibility.ThumbnailModel

Read only: True
Selected by default: False

IsDamMedia

System.Boolean

Read only: True
Selected by default: False

Resource Format

Response Formats
Copy
application/json
{
  "LastModified": "2026-10-17T00:02:56.7771623Z",
  "PublicationDate": "2026-10-17T00:02:56.7771623Z",
  "Title": "sample string 3",
  "Description": "sample string 4",
  "DateCreated": "2026-10-17T00:02:56.7771623Z",
  "IncludeInSitemap": true,
  "SystemSourceKey": "sample string 7",
  "Ordinal": 8.1,
  "UrlName": "sample string 9",
  "ItemDefaultUrl": "sample string 10",
  "Author": "sample string 11",
  "Extension": "sample string 12",
  "MimeType": "sample string 13",
  "TotalSize": 14,
  "regionscountries": "064df240-0fea-471b-ba77-4d6a1a95f484",
  "OptImgStatus": "sample string 16",
  "publishingoffices": "962c7e3a-0c8f-4994-add0-99413105b26d",
  "events": "d9952e38-e142-4948-ab4b-49898acf873a",
  "targets": "fc1c3e4e-7981-4c0d-8fce-e7af9785504a",
  "Category": "797c5dd3-b169-4218-b1ef-f36dff6398fc",
  "imagetypes": "0684b1d3-0993-49b1-b34f-33242a59d694",
  "JoomlaArticleId": "sample string 22",
  "departmentaltargets": "254653f9-f2e0-448a-94ae-5c4b0eda0555",
  "IsOptimized": true,
  "stakeholders": "0ccdce08-ca88-4464-8a8c-18cd62c14a35",
  "Tags": "015aac44-4686-4bb7-9e9d-64cca47ca91d",
  "healthtopics": "e1817d4f-0274-4be2-ab4c-dc15b041d56e",
  "targetaudiences": "d5889759-b196-42f5-84f8-0ee07a5d7900",
  "Width": 29,
  "Height": 30,
  "AlternativeText": "sample string 31",
  "FolderId": "69c135c6-e238-40a2-a840-56b1881b548d",
  "ParentId": "da0ea839-033b-40ea-86d6-94c0a0b7565f",
  "Provider": "sample string 34",
  "Url": "sample string 35",
  "ThumbnailUrl": "sample string 36",
  "Thumbnails": {
    "Title": "sample string 1",
    "Url": "sample string 2",
    "Width": 3,
    "Height": 4,
    "MimeType": "sample string 5"
  },
  "IsDamMedia": true
}

Post OpenGraphImage

Add OpenGraphImage relation to pages item.

Copy POST /api/default/pages({key})/OpenGraphImage/$ref
Request Informaion

URI Parameters

Name Description Type Additional Information
key

System.Guid

Required

Body Parameters

None

Request Formats
Copy
application/json
{
  "@odata.id": "http://host/route/service/type(key)"
}
Response Informaion

Resource Description

Method can return success code: NoContent - 204 or one of these error codes: BadRequest - 400, NotFound - 404, NotImplemented - 501, InternalServerError - 500, Unauthorized - 401.

Resource Format

Response Formats

None.

Delete OpenGraphImage

Delete set of related items of type OpenGraphImage from pages item.

Copy DELETE /api/default/pages({key})/OpenGraphImage/$ref
Request Informaion

URI Parameters

Name Description Type Additional Information
key

System.Guid

Required

Body Parameters

None

Request Formats

None.

Response Informaion

Resource Description

Method can return success code: NoContent - 204 or one of these error codes: BadRequest - 400, NotFound - 404, NotImplemented - 501, InternalServerError - 500, Unauthorized - 401.

Resource Format

Response Formats

None.

Delete OpenGraphImage by relatedKey

Delete relation of type OpenGraphImage from pages item.

Copy DELETE /api/default/pages({key})/OpenGraphImage({relatedKey})/$ref
Request Informaion

URI Parameters

Name Description Type Additional Information
key

System.Guid

Required

relatedKey

System.Guid

Required

Body Parameters

None

Request Formats

None.

Response Informaion

Resource Description

Method can return success code: NoContent - 204 or one of these error codes: BadRequest - 400, NotFound - 404, NotImplemented - 501, InternalServerError - 500, Unauthorized - 401.

Resource Format

Response Formats

None.