Site

get

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

siteKeystringRequired

Responses

200

Retrieve site information

application/json

idstringRequired

namestring · nullableOptional

descriptionstring · nullableOptional

defaultLocalestring · nullableOptional

timeZonestring · nullableOptional

404

Site not found

get

/api/v2/{siteKey}/public/site

HTTPcURLJavaScriptPython

GET /api/v2/{siteKey}/public/site HTTP/1.1
Host: app.venuecms.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "name": "text",
  "description": "text",
  "defaultLocale": "text",
  "timeZone": "text",
  "image": {
    "siteId": "text",
    "uploaded": true,
    "inline": true,
    "url": "text",
    "mimeType": "text",
    "size": "text",
    "width": 1,
    "height": 1,
    "duration": 1,
    "metadata": {},
    "title": "text",
    "caption": "text",
    "credit": "text",
    "altText": "text"
  },
  "settings": {
    "locale": {
      "default": "text",
      "supported": [
        "text"
      ]
    },
    "defaults": {
      "currency": "text",
      "event": {
        "location": "text"
      }
    },
    "publicSite": {
      "baseUrl": "text",
      "template": {
        "id": "text",
        "config": {
          "ANY_ADDITIONAL_PROPERTY": null
        },
        "schema": {
          "ANY_ADDITIONAL_PROPERTY": null
        }
      }
    }
  },
  "webSites": [
    {
      "id": "text",
      "siteId": "text",
      "customDomain": "text",
      "customSchemaId": "text",
      "config": {},
      "image": {
        "siteId": "text",
        "uploaded": true,
        "inline": true,
        "url": "text",
        "mimeType": "text",
        "size": "text",
        "width": 1,
        "height": 1,
        "duration": 1,
        "metadata": {},
        "title": "text",
        "caption": "text",
        "credit": "text",
        "altText": "text"
      },
      "localizedContent": [
        {
          "siteId": "text",
          "locale": "text",
          "title": "text",
          "content": "text",
          "shortContent": "text",
          "extraContent": "text",
          "excerpt": "text",
          "metaTitle": "text",
          "metaDescription": "text",
          "keywords": "text",
          "contentJSON": {}
        }
      ]
    }
  ]
}