Sites

getSiteInfo

GET
/api/v1/sites/{site_id}

Provides information about the site, including its name, address, timezone, and associated templates. This endpoint is useful for retrieving the current configuration and details of a specific site.

Authorization

Authorization<token>

Preferred authentication method for automation and integrations. Send the API token in the HTTP Authorization header.

Format: Authorization: Token {apitoken}

Notes:

  • An API token generated for a specific admin has the same privileges as that admin
  • An API token is automatically removed if it is not used for more than 90 days
  • SSO admins cannot generate admin API tokens. Use organization API tokens when scoped Org/Site privileges are needed.

In: header

Path Parameters

site_id*string
Formatuuid

Response Body

curl -X GET "https://example.com/api/v1/sites/000000ab-00ab-00ab-00ab-0000000000ab"
{  "address": "1601 S. Deanza Blvd., Cupertino, CA, 95014",  "alarmtemplate_id": "684dfc5c-fe77-2290-eb1d-ef3d677fe168",  "aptemplate_id": "16bdf952-ade2-4491-80b0-85ce506c760b",  "country_code": "US",  "created_time": 0,  "gatewaytemplate_id": "6f9b2e75-9b2f-b5ae-81e3-e14c76f1a90f",  "id": "497f6eca-6276-5005-bfeb-53cbbbba6f17",  "latlng": {    "lat": 37.295833,    "lng": -122.032946  },  "modified_time": 0,  "name": "Mist Office",  "networktemplate_id": "12ae9bd2-e0ab-107b-72e8-a7a005565ec2",  "notes": "string",  "org_id": "a40f5d1f-d889-42e9-94ea-b9b33585fc6b",  "rftemplate_id": "bb8a9017-1e36-5d6c-6f2b-551abe8a76a2",  "secpolicy_id": "3bcd0beb-5d0a-4cbd-92c1-14aea91e98ef",  "sitegroup_ids": [    "497f6eca-6276-5006-bfeb-53cbbbba6f18"  ],  "timezone": "America/Los_Angeles"}