8X8x8
Sites

Get site by ID

Retrieve a specific site by its ID

get/sites/{siteId}

Request

Path parameters

siteIdstring required
Example:0023OEZiR7qQ_EGb6xYjgg

Site identifier

Headers

X-Request-Idstring uuid

Optional request identifier for tracking

Response

Site retrieved successfully

idstring nullable
namestring required
pbxNamestring required
locale'da-DK' | 'de-DE' | 'en-AU' | 'en-GB' | 'en-US' | 'es-ES' | 'fi-FI' | 'fr-BE' | 'fr-CA' | 'fr-CH' | 'fr-FR' | 'it-IT' | 'ja-JP' | 'nl-BE' | 'nl-NL' | 'no-NO' | 'pl-PL' | 'pt-BR' | 'pt-PT' | 'sv-SE' | 'zh-CN' required
timezonestring required
siteCodestring nullable
extensionLengthinteger nullable
defaultDialPlanCallingCountrystring nullable
defaultDialPlanRuleset'INTERNATIONAL' | 'DOMESTIC' | 'EMERGENCYONLY' nullable
defaultVoicemailZeroOutDestinationExtensionIdstring nullable
defaultVoicemailZeroOutDestinationExtensionNumberstring nullable

Example response

{
  "id": "0023OEZiR7qQ_EGb6xYjgg",
  "name": "SanJose-Onel",
  "locale": "en-US",
  "timezone": "Europe/London",
  "address": {
    "id": "b1c4944a-17a0-4b00-8d48-36001df07e22"
  },
  "siteCode": "1345",
  "extensionLength": 4,
  "emergencyNotifications": [
    {
      "type": "EMAIL",
      "values": [
        "john.doe@corp.com",
        "jane.doe@corp.com"
      ]
    }
  ],
  "callerIdSettings": {
    "mainNumber": "+12266280120",
    "setMainNumberAsCallerId": true,
    "displayName": "John Doe"
  },
  "defaultDialPlanCallingCountry": "NANP",
  "defaultDialPlanRuleset": "INTERNATIONAL",
  "defaultVoicemailZeroOutDestinationExtensionId": "0ejGzqYBSIiMloUrreLXmA",
  "defaultVoicemailZeroOutDestinationExtensionNumber": "1032"
}

Changes

No recorded changes to this operation across all 1 revision of this API.