Sites API: Pages

Retrieves one specific page

get

Authorizations

BearerCookie

BearerstringRequired

Path parameters

pagestring · uuidRequired

Responses

404

Not Found

application/jsontext/json

get

/api/sites/pages/{page}

HTTPcURLJavaScriptPython

GET /v2/e01/api/sites/pages/{page} HTTP/1.1
Bearer: YOUR_API_KEY
Accept: */*

404

Not Found

{
  "Type": "text",
  "Title": "text",
  "Status": 1,
  "Detail": "text",
  "Instance": "text",
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Checks for the existence of one specific page

head

Authorizations

BearerCookie

BearerstringRequired

Path parameters

pagestring · uuidRequired

Responses

200

OK

No content

404

Not Found

application/jsontext/json

head

/api/sites/pages/{page}

HTTPcURLJavaScriptPython

HEAD /v2/e01/api/sites/pages/{page} HTTP/1.1
Bearer: YOUR_API_KEY
Accept: */*

No content

Collects the list of pages that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

ObjectIdstring · uuid · nullableOptional

ParentPageIdstring · uuid · nullableOptional

SiteIdstring · uuid · nullableOptional

IsAccessDeniedboolean · nullableOptional

IsHiddenboolean · nullableOptional

IsNewTabboolean · nullableOptional

IsNullNavigateUrlboolean · nullableOptional

AuthorNamestring · nullableOptional

ContentControlstring · nullableOptional

ContentLabelsstring · nullableOptional

Hookstring · nullableOptional

LastChangeTypestring · nullableOptional

LastChangeUserstring · nullableOptional

NavigateUrlstring · nullableOptional

ObjectTypestring · nullableOptional

PageIconstring · nullableOptional

PageSlugstring · nullableOptional

PageTypestring · nullableOptional

ParentPageSlugstring · nullableOptional

ParentPageTypestring · nullableOptional

SiteDomainstring · nullableOptional

Titlestring · nullableOptional

Sequenceinteger · int32 · nullableOptional

AuthorDateSincestring · date-time · nullableOptional

AuthorDateBeforestring · date-time · nullableOptional

LastChangeTimeSincestring · date-time · nullableOptional

LastChangeTimeBeforestring · date-time · nullableOptional

Responses

200

OK

application/jsontext/json

ObjectIdstring · uuid · nullableOptional

PageIdstring · uuidOptional

ParentPageIdstring · uuid · nullableOptional

SiteIdstring · uuid · nullableOptional

IsAccessDeniedbooleanOptional

IsHiddenbooleanOptional

IsNewTabbooleanOptional

AuthorNamestring · nullableOptional

ContentControlstring · nullableOptional

ContentLabelsstring · nullableOptional

Hookstring · nullableOptional

LastChangeTypestring · nullableOptional

LastChangeUserstring · nullableOptional

NavigateUrlstring · nullableOptional

ObjectTypestring · nullableOptional

PageIconstring · nullableOptional

PageSlugstring · nullableOptional

PageTypestring · nullableOptional

Titlestring · nullableOptional

Sequenceinteger · int32Optional

AuthorDatestring · date-time · nullableOptional

LastChangeTimestring · date-time · nullableOptional

post

/api/sites/pages/collect

HTTPcURLJavaScriptPython

POST /v2/e01/api/sites/pages/collect HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 742

{
  "ObjectId": "123e4567-e89b-12d3-a456-426614174000",
  "ParentPageId": "123e4567-e89b-12d3-a456-426614174000",
  "SiteId": "123e4567-e89b-12d3-a456-426614174000",
  "IsAccessDenied": true,
  "IsHidden": true,
  "IsNewTab": true,
  "IsNullNavigateUrl": true,
  "AuthorName": "text",
  "ContentControl": "text",
  "ContentLabels": "text",
  "Hook": "text",
  "LastChangeType": "text",
  "LastChangeUser": "text",
  "NavigateUrl": "text",
  "ObjectType": "text",
  "PageIcon": "text",
  "PageSlug": "text",
  "PageType": "text",
  "ParentPageSlug": "text",
  "ParentPageType": "text",
  "SiteDomain": "text",
  "Title": "text",
  "Sequence": 1,
  "AuthorDateSince": "2026-05-07T18:20:49.588Z",
  "AuthorDateBefore": "2026-05-07T18:20:49.588Z",
  "LastChangeTimeSince": "2026-05-07T18:20:49.588Z",
  "LastChangeTimeBefore": "2026-05-07T18:20:49.588Z"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

[
  {
    "ObjectId": "123e4567-e89b-12d3-a456-426614174000",
    "PageId": "123e4567-e89b-12d3-a456-426614174000",
    "ParentPageId": "123e4567-e89b-12d3-a456-426614174000",
    "SiteId": "123e4567-e89b-12d3-a456-426614174000",
    "IsAccessDenied": true,
    "IsHidden": true,
    "IsNewTab": true,
    "AuthorName": "text",
    "ContentControl": "text",
    "ContentLabels": "text",
    "Hook": "text",
    "LastChangeType": "text",
    "LastChangeUser": "text",
    "NavigateUrl": "text",
    "ObjectType": "text",
    "PageIcon": "text",
    "PageSlug": "text",
    "PageType": "text",
    "Title": "text",
    "Sequence": 1,
    "AuthorDate": "2026-05-07T18:20:49.588Z",
    "LastChangeTime": "2026-05-07T18:20:49.588Z"
  }
]

Counts the pages that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

ObjectIdstring · uuid · nullableOptional

ParentPageIdstring · uuid · nullableOptional

SiteIdstring · uuid · nullableOptional

IsAccessDeniedboolean · nullableOptional

IsHiddenboolean · nullableOptional

IsNewTabboolean · nullableOptional

IsNullNavigateUrlboolean · nullableOptional

AuthorNamestring · nullableOptional

ContentControlstring · nullableOptional

ContentLabelsstring · nullableOptional

Hookstring · nullableOptional

LastChangeTypestring · nullableOptional

LastChangeUserstring · nullableOptional

NavigateUrlstring · nullableOptional

ObjectTypestring · nullableOptional

PageIconstring · nullableOptional

PageSlugstring · nullableOptional

PageTypestring · nullableOptional

ParentPageSlugstring · nullableOptional

ParentPageTypestring · nullableOptional

SiteDomainstring · nullableOptional

Titlestring · nullableOptional

Sequenceinteger · int32 · nullableOptional

AuthorDateSincestring · date-time · nullableOptional

AuthorDateBeforestring · date-time · nullableOptional

LastChangeTimeSincestring · date-time · nullableOptional

LastChangeTimeBeforestring · date-time · nullableOptional

Responses

200

OK

application/jsontext/json

Countinteger · int32Optional

Summarystring · nullableOptional

post

/api/sites/pages/count

HTTPcURLJavaScriptPython

POST /v2/e01/api/sites/pages/count HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 742

{
  "ObjectId": "123e4567-e89b-12d3-a456-426614174000",
  "ParentPageId": "123e4567-e89b-12d3-a456-426614174000",
  "SiteId": "123e4567-e89b-12d3-a456-426614174000",
  "IsAccessDenied": true,
  "IsHidden": true,
  "IsNewTab": true,
  "IsNullNavigateUrl": true,
  "AuthorName": "text",
  "ContentControl": "text",
  "ContentLabels": "text",
  "Hook": "text",
  "LastChangeType": "text",
  "LastChangeUser": "text",
  "NavigateUrl": "text",
  "ObjectType": "text",
  "PageIcon": "text",
  "PageSlug": "text",
  "PageType": "text",
  "ParentPageSlug": "text",
  "ParentPageType": "text",
  "SiteDomain": "text",
  "Title": "text",
  "Sequence": 1,
  "AuthorDateSince": "2026-05-07T18:20:49.588Z",
  "AuthorDateBefore": "2026-05-07T18:20:49.588Z",
  "LastChangeTimeSince": "2026-05-07T18:20:49.588Z",
  "LastChangeTimeBefore": "2026-05-07T18:20:49.588Z"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

{
  "Count": 1,
  "Summary": "text"
}

Downloads the list of pages that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

ObjectIdstring · uuid · nullableOptional

ParentPageIdstring · uuid · nullableOptional

SiteIdstring · uuid · nullableOptional

IsAccessDeniedboolean · nullableOptional

IsHiddenboolean · nullableOptional

IsNewTabboolean · nullableOptional

IsNullNavigateUrlboolean · nullableOptional

AuthorNamestring · nullableOptional

ContentControlstring · nullableOptional

ContentLabelsstring · nullableOptional

Hookstring · nullableOptional

LastChangeTypestring · nullableOptional

LastChangeUserstring · nullableOptional

NavigateUrlstring · nullableOptional

ObjectTypestring · nullableOptional

PageIconstring · nullableOptional

PageSlugstring · nullableOptional

PageTypestring · nullableOptional

ParentPageSlugstring · nullableOptional

ParentPageTypestring · nullableOptional

SiteDomainstring · nullableOptional

Titlestring · nullableOptional

Sequenceinteger · int32 · nullableOptional

AuthorDateSincestring · date-time · nullableOptional

AuthorDateBeforestring · date-time · nullableOptional

LastChangeTimeSincestring · date-time · nullableOptional

LastChangeTimeBeforestring · date-time · nullableOptional

Responses

200

OK

No content

post

/api/sites/pages/download

HTTPcURLJavaScriptPython

POST /v2/e01/api/sites/pages/download HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 742

{
  "ObjectId": "123e4567-e89b-12d3-a456-426614174000",
  "ParentPageId": "123e4567-e89b-12d3-a456-426614174000",
  "SiteId": "123e4567-e89b-12d3-a456-426614174000",
  "IsAccessDenied": true,
  "IsHidden": true,
  "IsNewTab": true,
  "IsNullNavigateUrl": true,
  "AuthorName": "text",
  "ContentControl": "text",
  "ContentLabels": "text",
  "Hook": "text",
  "LastChangeType": "text",
  "LastChangeUser": "text",
  "NavigateUrl": "text",
  "ObjectType": "text",
  "PageIcon": "text",
  "PageSlug": "text",
  "PageType": "text",
  "ParentPageSlug": "text",
  "ParentPageType": "text",
  "SiteDomain": "text",
  "Title": "text",
  "Sequence": 1,
  "AuthorDateSince": "2026-05-07T18:20:49.588Z",
  "AuthorDateBefore": "2026-05-07T18:20:49.588Z",
  "LastChangeTimeSince": "2026-05-07T18:20:49.588Z",
  "LastChangeTimeBefore": "2026-05-07T18:20:49.588Z"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

No content

Searches for the list of pages that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

ObjectIdstring · uuid · nullableOptional

ParentPageIdstring · uuid · nullableOptional

SiteIdstring · uuid · nullableOptional

IsAccessDeniedboolean · nullableOptional

IsHiddenboolean · nullableOptional

IsNewTabboolean · nullableOptional

IsNullNavigateUrlboolean · nullableOptional

AuthorNamestring · nullableOptional

ContentControlstring · nullableOptional

ContentLabelsstring · nullableOptional

Hookstring · nullableOptional

LastChangeTypestring · nullableOptional

LastChangeUserstring · nullableOptional

NavigateUrlstring · nullableOptional

ObjectTypestring · nullableOptional

PageIconstring · nullableOptional

PageSlugstring · nullableOptional

PageTypestring · nullableOptional

ParentPageSlugstring · nullableOptional

ParentPageTypestring · nullableOptional

SiteDomainstring · nullableOptional

Titlestring · nullableOptional

Sequenceinteger · int32 · nullableOptional

AuthorDateSincestring · date-time · nullableOptional

AuthorDateBeforestring · date-time · nullableOptional

LastChangeTimeSincestring · date-time · nullableOptional

LastChangeTimeBeforestring · date-time · nullableOptional

Responses

200

OK

application/jsontext/json

PageIdstring · uuidOptional

PageIconstring · nullableOptional

PageTitlestring · nullableOptional

PageUrlstring · nullableOptional

post

/api/sites/pages/search

HTTPcURLJavaScriptPython

POST /v2/e01/api/sites/pages/search HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 742

{
  "ObjectId": "123e4567-e89b-12d3-a456-426614174000",
  "ParentPageId": "123e4567-e89b-12d3-a456-426614174000",
  "SiteId": "123e4567-e89b-12d3-a456-426614174000",
  "IsAccessDenied": true,
  "IsHidden": true,
  "IsNewTab": true,
  "IsNullNavigateUrl": true,
  "AuthorName": "text",
  "ContentControl": "text",
  "ContentLabels": "text",
  "Hook": "text",
  "LastChangeType": "text",
  "LastChangeUser": "text",
  "NavigateUrl": "text",
  "ObjectType": "text",
  "PageIcon": "text",
  "PageSlug": "text",
  "PageType": "text",
  "ParentPageSlug": "text",
  "ParentPageType": "text",
  "SiteDomain": "text",
  "Title": "text",
  "Sequence": 1,
  "AuthorDateSince": "2026-05-07T18:20:49.588Z",
  "AuthorDateBefore": "2026-05-07T18:20:49.588Z",
  "LastChangeTimeSince": "2026-05-07T18:20:49.588Z",
  "LastChangeTimeBefore": "2026-05-07T18:20:49.588Z"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

[
  {
    "PageId": "123e4567-e89b-12d3-a456-426614174000",
    "PageIcon": "text",
    "PageTitle": "text",
    "PageUrl": "text"
  }
]

get

Authorizations

BearerCookie

BearerstringRequired

Path parameters

pagestring · uuidRequired

Responses

404

Not Found

application/jsontext/json

get

/api/sites/pages-contents/{page}

HTTPcURLJavaScriptPython

GET /v2/e01/api/sites/pages-contents/{page} HTTP/1.1
Bearer: YOUR_API_KEY
Accept: */*

404

Not Found

{
  "Type": "text",
  "Title": "text",
  "Status": 1,
  "Detail": "text",
  "Instance": "text",
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

put

Authorizations

BearerCookie

BearerstringRequired

Path parameters

pagestring · uuidRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

DeletedBlockIdsstring · uuid[] · nullableOptional

Responses

200

OK

application/jsontext/json

Other propertiesstring · uuidOptional

put

/api/sites/pages-contents/{page}

HTTPcURLJavaScriptPython

PUT /v2/e01/api/sites/pages-contents/{page} HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 2076

{
  "Content": {
    "IsLoaded": true,
    "Title": {
      "Text": [
        {
          "Key": "text",
          "Value": "text"
        }
      ],
      "Html": [
        {
          "Key": "text",
          "Value": "text"
        }
      ],
      "Snip": [
        {
          "Key": "text",
          "Value": "text"
        }
      ]
    },
    "Summary": {
      "Text": [
        {
          "Key": "text",
          "Value": "text"
        }
      ],
      "Html": [
        {
          "Key": "text",
          "Value": "text"
        }
      ],
      "Snip": [
        {
          "Key": "text",
          "Value": "text"
        }
      ]
    },
    "Description": {
      "Text": [
        {
          "Key": "text",
          "Value": "text"
        }
      ],
      "Html": [
        {
          "Key": "text",
          "Value": "text"
        }
      ],
      "Snip": [
        {
          "Key": "text",
          "Value": "text"
        }
      ]
    },
    "Feedback": {
      "Text": [
        {
          "Key": "text",
          "Value": "text"
        }
      ],
      "Html": [
        {
          "Key": "text",
          "Value": "text"
        }
      ],
      "Snip": [
        {
          "Key": "text",
          "Value": "text"
        }
      ]
    },
    "FeedbackWhenNotSelected": {
      "Text": [
        {
          "Key": "text",
          "Value": "text"
        }
      ],
      "Html": [
        {
          "Key": "text",
          "Value": "text"
        }
      ],
      "Snip": [
        {
          "Key": "text",
          "Value": "text"
        }
      ]
    },
    "Hint": {
      "Text": [
        {
          "Key": "text",
          "Value": "text"
        }
      ],
      "Html": [
        {
          "Key": "text",
          "Value": "text"
        }
      ],
      "Snip": [
        {
          "Key": "text",
          "Value": "text"
        }
      ]
    },
    "Body": {
      "Text": [
        {
          "Key": "text",
          "Value": "text"
        }
      ],
      "Html": [
        {
          "Key": "text",
          "Value": "text"
        }
      ],
      "Snip": [
        {
          "Key": "text",
          "Value": "text"
        }
      ]
    }
  },
  "Blocks": [
    {
      "BlockId": "123e4567-e89b-12d3-a456-426614174000",
      "BlockIdNumber": 1,
      "BlockType": "text",
      "Title": "text",
      "Hook": "text",
      "Content": {
        "IsLoaded": true,
        "Title": {
          "Text": [
            {
              "Key": "text",
              "Value": "text"
            }
          ],
          "Html": [
            {
              "Key": "text",
              "Value": "text"
            }
          ],
          "Snip": [
            {
              "Key": "text",
              "Value": "text"
            }
          ]
        },
        "Summary": {
          "Text": [
            {
              "Key": "text",
              "Value": "text"
            }
          ],
          "Html": [
            {
              "Key": "text",
              "Value": "text"
            }
          ],
          "Snip": [
            {
              "Key": "text",
              "Value": "text"
            }
          ]
        },
        "Description": {
          "Text": [
            {
              "Key": "text",
              "Value": "text"
            }
          ],
          "Html": [
            {
              "Key": "text",
              "Value": "text"
            }
          ],
          "Snip": [
            {
              "Key": "text",
              "Value": "text"
            }
          ]
        },
        "Feedback": {
          "Text": [
            {
              "Key": "text",
              "Value": "text"
            }
          ],
          "Html": [
            {
              "Key": "text",
              "Value": "text"
            }
          ],
          "Snip": [
            {
              "Key": "text",
              "Value": "text"
            }
          ]
        },
        "FeedbackWhenNotSelected": {
          "Text": [
            {
              "Key": "text",
              "Value": "text"
            }
          ],
          "Html": [
            {
              "Key": "text",
              "Value": "text"
            }
          ],
          "Snip": [
            {
              "Key": "text",
              "Value": "text"
            }
          ]
        },
        "Hint": {
          "Text": [
            {
              "Key": "text",
              "Value": "text"
            }
          ],
          "Html": [
            {
              "Key": "text",
              "Value": "text"
            }
          ],
          "Snip": [
            {
              "Key": "text",
              "Value": "text"
            }
          ]
        },
        "Body": {
          "Text": [
            {
              "Key": "text",
              "Value": "text"
            }
          ],
          "Html": [
            {
              "Key": "text",
              "Value": "text"
            }
          ],
          "Snip": [
            {
              "Key": "text",
              "Value": "text"
            }
          ]
        }
      }
    }
  ],
  "DeletedBlockIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

{
  "ANY_ADDITIONAL_PROPERTY": "123e4567-e89b-12d3-a456-426614174000"
}