Open API v2 / CMS & Content / System Pages

System Pages

→

Every request needs a bearer token: Authorization: Bearer <token>. Base URL https://your-site.webinone.com. New to field types? See the type reference.

GET/api/v2/admin/system-pages#

Retrieves a list of system pages by using a "where" filtering

Parameters

Wherestring · query

JSON filter expression. Combine operators ($eq, $contains, $gt, $in, …) with $and / $or.

Order_Bystring · query

Sort field. Prefix with - for descending; comma-separate for tie-breakers.

Semantic_Querystring · query

Natural-language search, ranked by relevance.

Min_Scorenumber · query

Lowest relevance score to include when using Semantic_Query.

Offsetinteger · query

Number of items to skip before returning results. Defaults to 0.

Limitinteger · query

Maximum number of items to return. Defaults to 100.

Response

Idinteger

Unique identifier. Technical record number in the database. Url - path to the page on the website. Name - internal name for administrator. Read-only.

Urlstring · nullable

URL.

Namestring · nullable

Name of the system page.

Descriptionstring · nullable

The main text and visual content of the page.

TemplateIdinteger

Layout template identifier. It defines the page structure: the presence of a header, footer, and sidebars into which the system page content will be embedded.

Enableboolean

Page activity status.

curl "https://your-site.webinone.com/api/v2/admin/system-pages" \
  -H "Authorization: Bearer <token>"

await fetch("https://your-site.webinone.com/api/v2/admin/system-pages", {
  method: "GET",
  headers: {
    "Authorization": "Bearer <token>"
  }
});

import requests

requests.get(
    "https://your-site.webinone.com/api/v2/admin/system-pages",
    headers={"Authorization": "Bearer <token>"}
)

$client = new GuzzleHttp\Client();
$response = $client->request('GET', 'https://your-site.webinone.com/api/v2/admin/system-pages', [
    'headers' => [
        'Authorization' => 'Bearer <token>'
    ]
]);

using var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://your-site.webinone.com/api/v2/admin/system-pages");
request.Headers.Add("Authorization", "Bearer <token>");
var response = await client.SendAsync(request);

Response · 200

{
  "Items": [
    {
      "Id": 1,
      "Url": "https://example.com",
      "Name": "Example",
      "Description": "string",
      "TemplateId": 1,
      "Enable": false
    }
  ],
  "TotalItemsCount": 0
}

GET/api/v2/admin/system-pages/{id}#

Retrieves a single system page

Parameters

idinteger · pathrequired

System page id.

Response

Idinteger

Unique identifier. Technical record number in the database. Url - path to the page on the website. Name - internal name for administrator. Read-only.

Urlstring · nullable

URL.

Namestring · nullable

Name of the system page.

Descriptionstring · nullable

The main text and visual content of the page.

TemplateIdinteger

Layout template identifier. It defines the page structure: the presence of a header, footer, and sidebars into which the system page content will be embedded.

Enableboolean

Page activity status.

curl "https://your-site.webinone.com/api/v2/admin/system-pages/1" \
  -H "Authorization: Bearer <token>"

await fetch("https://your-site.webinone.com/api/v2/admin/system-pages/1", {
  method: "GET",
  headers: {
    "Authorization": "Bearer <token>"
  }
});

import requests

requests.get(
    "https://your-site.webinone.com/api/v2/admin/system-pages/1",
    headers={"Authorization": "Bearer <token>"}
)

$client = new GuzzleHttp\Client();
$response = $client->request('GET', 'https://your-site.webinone.com/api/v2/admin/system-pages/1', [
    'headers' => [
        'Authorization' => 'Bearer <token>'
    ]
]);

using var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://your-site.webinone.com/api/v2/admin/system-pages/1");
request.Headers.Add("Authorization", "Bearer <token>");
var response = await client.SendAsync(request);

Response · 200

{
  "Id": 1,
  "Url": "https://example.com",
  "Name": "Example",
  "Description": "string",
  "TemplateId": 1,
  "Enable": false
}

PUT/api/v2/admin/system-pages/{id}#

Updates an existing system page

Parameters

idinteger · pathrequired

Existent system page id.

Body parameters

Descriptionstring · nullable

The main text and visual content of the page.

TemplateIdintegerrequired

Layout template identifier. It defines the page structure: the presence of a header, footer, and sidebars into which the system page content will be embedded.

Enableboolean

Page activity status. If true, the page is available at its system address. If false — the page is disabled.

Response

Idinteger

Unique identifier. Technical record number in the database. Url - path to the page on the website. Name - internal name for administrator. Read-only.

Urlstring · nullable

URL.

Namestring · nullable

Name of the system page.

Descriptionstring · nullable

The main text and visual content of the page.

TemplateIdinteger

Layout template identifier. It defines the page structure: the presence of a header, footer, and sidebars into which the system page content will be embedded.

Enableboolean

Page activity status.

curl -X PUT "https://your-site.webinone.com/api/v2/admin/system-pages/1" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"Description":"string","TemplateId":1,"Enable":false}'

await fetch("https://your-site.webinone.com/api/v2/admin/system-pages/1", {
  method: "PUT",
  headers: {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "Description": "string",
    "TemplateId": 1,
    "Enable": false
  })
});

import requests

requests.put(
    "https://your-site.webinone.com/api/v2/admin/system-pages/1",
    headers={"Authorization": "Bearer <token>"},
    json={
        "Description": "string",
        "TemplateId": 1,
        "Enable": False
    }
)

$client = new GuzzleHttp\Client();
$response = $client->request('PUT', 'https://your-site.webinone.com/api/v2/admin/system-pages/1', [
    'headers' => [
        'Authorization' => 'Bearer <token>',
        'Content-Type' => 'application/json'
    ],
    'json' => [
        'Description' => 'string',
        'TemplateId' => 1,
        'Enable' => false
    ]
]);

using var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "https://your-site.webinone.com/api/v2/admin/system-pages/1");
request.Headers.Add("Authorization", "Bearer <token>");
request.Content = new StringContent(
    "{\"Description\":\"string\",\"TemplateId\":1,\"Enable\":false}",
    Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);

Response · 200

{
  "Id": 1,
  "Url": "https://example.com",
  "Name": "Example",
  "Description": "string",
  "TemplateId": 1,
  "Enable": false
}

GET/api/v2/admin/system-pages/{id}/seo#

Retrieves a single system page seo

Parameters

idinteger · pathrequired

System page id.

Response

Idinteger

Unique identifier. Technical record number in the database. Url - path to the page on the website. Name - internal name for administrator. Read-only.

Namestring · nullable

Name of the system page seo.

SEOTitlestring · nullable

Title tag shown in the browser tab and used by search engines for this system page.

MetaDescriptionstring · nullable

Meta description summarizing the page, used by search engines in result snippets.

ShowPageForSearchEngineboolean

Show page for search engine.

CanonicalLinkstring · nullable

Canonical URL that tells search engines the preferred address for this page, consolidating duplicate content.

EnableAMPboolean

Whether enable amp is on.

AMPContentstring · nullable

Accelerated Mobile Pages markup served as the fast-loading mobile version of this system page.

SocialMetaTagsstring · nullable

Extra social sharing meta tags injected into the page head for platforms that read them when the page is shared.

SeoPrioritynumber

Priority hint for this page in the generated XML sitemap, signalling its relative importance to search crawlers.

Urlstring · nullable

URL.

OpenGraphPropertiesobject

Open Graph metadata controlling how the page appears when shared on social networks, such as the title, type, image and locale.

curl "https://your-site.webinone.com/api/v2/admin/system-pages/1/seo" \
  -H "Authorization: Bearer <token>"

await fetch("https://your-site.webinone.com/api/v2/admin/system-pages/1/seo", {
  method: "GET",
  headers: {
    "Authorization": "Bearer <token>"
  }
});

import requests

requests.get(
    "https://your-site.webinone.com/api/v2/admin/system-pages/1/seo",
    headers={"Authorization": "Bearer <token>"}
)

$client = new GuzzleHttp\Client();
$response = $client->request('GET', 'https://your-site.webinone.com/api/v2/admin/system-pages/1/seo', [
    'headers' => [
        'Authorization' => 'Bearer <token>'
    ]
]);

using var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://your-site.webinone.com/api/v2/admin/system-pages/1/seo");
request.Headers.Add("Authorization", "Bearer <token>");
var response = await client.SendAsync(request);

Response · 200

{
  "Id": 1,
  "Name": "Example",
  "SEOTitle": "string",
  "MetaDescription": "string",
  "ShowPageForSearchEngine": false,
  "CanonicalLink": "string",
  "EnableAMP": false,
  "AMPContent": "string",
  "SocialMetaTags": "string",
  "SeoPriority": 0,
  "Url": "https://example.com",
  "OpenGraphProperties": {
    "title": "string",
    "type": "string",
    "url": "https://example.com",
    "locale": "string",
    "image": "string"
  }
}

PUT/api/v2/admin/system-pages/{id}/seo#

Updates an existing system page seo

Parameters

idinteger · pathrequired

Existent system page id.

Body parameters

SEOTitlestring · nullable

Title tag shown in the browser tab and used by search engines for this system page.

MetaDescriptionstring · nullable

Meta description summarizing the page, used by search engines in result snippets.

ShowPageForSearchEngineboolean

Show page for search engine.

CanonicalLinkstring · nullable

Canonical URL that tells search engines the preferred address for this page, consolidating duplicate content.

EnableAMPboolean

Whether enable amp is on.

AMPContentstring · nullable

Accelerated Mobile Pages markup served as the fast-loading mobile version of this system page.

SocialMetaTagsstring · nullable

Extra social sharing meta tags injected into the page head for platforms that read them when the page is shared.

SeoPrioritynumber

Priority hint for this page in the generated XML sitemap, signalling its relative importance to search crawlers.

OpenGraphPropertiesobject

Open Graph metadata controlling how the page appears when shared on social networks, such as the title, type, image and locale.

Response

Idinteger

Unique identifier. Technical record number in the database. Url - path to the page on the website. Name - internal name for administrator. Read-only.

Namestring · nullable

Name of the system page seo.

SEOTitlestring · nullable

Title tag shown in the browser tab and used by search engines for this system page.

MetaDescriptionstring · nullable

Meta description summarizing the page, used by search engines in result snippets.

ShowPageForSearchEngineboolean

Show page for search engine.

CanonicalLinkstring · nullable

Canonical URL that tells search engines the preferred address for this page, consolidating duplicate content.

EnableAMPboolean

Whether enable amp is on.

AMPContentstring · nullable

Accelerated Mobile Pages markup served as the fast-loading mobile version of this system page.

SocialMetaTagsstring · nullable

Extra social sharing meta tags injected into the page head for platforms that read them when the page is shared.

SeoPrioritynumber

Priority hint for this page in the generated XML sitemap, signalling its relative importance to search crawlers.

Urlstring · nullable

URL.

OpenGraphPropertiesobject

Open Graph metadata controlling how the page appears when shared on social networks, such as the title, type, image and locale.

curl -X PUT "https://your-site.webinone.com/api/v2/admin/system-pages/1/seo" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"SEOTitle":"string","MetaDescription":"string","ShowPageForSearchEngine":false,"CanonicalLink":"string","EnableAMP":false,"AMPContent":"string","SocialMetaTags":"string","SeoPriority":0,"OpenGraphProperties":{"title":"string","type":"string","url":"https://example.com","locale":"string","image":"string"}}'

await fetch("https://your-site.webinone.com/api/v2/admin/system-pages/1/seo", {
  method: "PUT",
  headers: {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "SEOTitle": "string",
    "MetaDescription": "string",
    "ShowPageForSearchEngine": false,
    "CanonicalLink": "string",
    "EnableAMP": false,
    "AMPContent": "string",
    "SocialMetaTags": "string",
    "SeoPriority": 0,
    "OpenGraphProperties": {
      "title": "string",
      "type": "string",
      "url": "https://example.com",
      "locale": "string",
      "image": "string"
    }
  })
});

import requests

requests.put(
    "https://your-site.webinone.com/api/v2/admin/system-pages/1/seo",
    headers={"Authorization": "Bearer <token>"},
    json={
        "SEOTitle": "string",
        "MetaDescription": "string",
        "ShowPageForSearchEngine": False,
        "CanonicalLink": "string",
        "EnableAMP": False,
        "AMPContent": "string",
        "SocialMetaTags": "string",
        "SeoPriority": 0,
        "OpenGraphProperties": {
            "title": "string",
            "type": "string",
            "url": "https://example.com",
            "locale": "string",
            "image": "string"
        }
    }
)

$client = new GuzzleHttp\Client();
$response = $client->request('PUT', 'https://your-site.webinone.com/api/v2/admin/system-pages/1/seo', [
    'headers' => [
        'Authorization' => 'Bearer <token>',
        'Content-Type' => 'application/json'
    ],
    'json' => [
        'SEOTitle' => 'string',
        'MetaDescription' => 'string',
        'ShowPageForSearchEngine' => false,
        'CanonicalLink' => 'string',
        'EnableAMP' => false,
        'AMPContent' => 'string',
        'SocialMetaTags' => 'string',
        'SeoPriority' => 0,
        'OpenGraphProperties' => [
            'title' => 'string',
            'type' => 'string',
            'url' => 'https://example.com',
            'locale' => 'string',
            'image' => 'string'
        ]
    ]
]);

using var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "https://your-site.webinone.com/api/v2/admin/system-pages/1/seo");
request.Headers.Add("Authorization", "Bearer <token>");
request.Content = new StringContent(
    "{\"SEOTitle\":\"string\",\"MetaDescription\":\"string\",\"ShowPageForSearchEngine\":false,\"CanonicalLink\":\"string\",\"EnableAMP\":false,\"AMPContent\":\"string\",\"SocialMetaTags\":\"string\",\"SeoPriority\":0,\"OpenGraphProperties\":{\"title\":\"string\",\"type\":\"string\",\"url\":\"https://example.com\",\"locale\":\"string\",\"image\":\"string\"}}",
    Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);

Response · 200

{
  "Id": 1,
  "Name": "Example",
  "SEOTitle": "string",
  "MetaDescription": "string",
  "ShowPageForSearchEngine": false,
  "CanonicalLink": "string",
  "EnableAMP": false,
  "AMPContent": "string",
  "SocialMetaTags": "string",
  "SeoPriority": 0,
  "Url": "https://example.com",
  "OpenGraphProperties": {
    "title": "string",
    "type": "string",
    "url": "https://example.com",
    "locale": "string",
    "image": "string"
  }
}

GET/api/v2/admin/system-pages/restore-to-default/{id}#

Retrieves a single system page

Parameters

idinteger · pathrequired

System page id.

Response

curl "https://your-site.webinone.com/api/v2/admin/system-pages/restore-to-default/1" \
  -H "Authorization: Bearer <token>"

await fetch("https://your-site.webinone.com/api/v2/admin/system-pages/restore-to-default/1", {
  method: "GET",
  headers: {
    "Authorization": "Bearer <token>"
  }
});

import requests

requests.get(
    "https://your-site.webinone.com/api/v2/admin/system-pages/restore-to-default/1",
    headers={"Authorization": "Bearer <token>"}
)

$client = new GuzzleHttp\Client();
$response = $client->request('GET', 'https://your-site.webinone.com/api/v2/admin/system-pages/restore-to-default/1', [
    'headers' => [
        'Authorization' => 'Bearer <token>'
    ]
]);

using var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://your-site.webinone.com/api/v2/admin/system-pages/restore-to-default/1");
request.Headers.Add("Authorization", "Bearer <token>");
var response = await client.SendAsync(request);

Response · 200

"string"