v1

latestOpenAPI 3.0.12026-08-06135498863.0 KB

Sites

Gets a Site

Returns a detailed site and its related data based on the provided siteId.

Licenses Required

Vista.Ocapi

get/ocapi/v1/sites/{siteId}

Path parameters

siteIdstring required

The unique identifier of site

Headers

Connect-Region-Codestring

Region Code

Response

Success

Example response

{
  "site": {
    "contactDetails": {
      "address": {
        "line1": "60 Khyber Pass Road",
        "line2": "Grafton",
        "city": "Auckland 1023"
      }
    },
    "ianaTimeZoneName": "America/New_York",
    "name": {
      "translations": [
        {
          "languageTag": "en-US"
        }
      ]
    }
  }
}