Sites

Get a site

One site with the same fields as list_sites. Call it to check the state of a site you already know, e.g. whether it is suspended before turning widgets on with update_widgets.

get/v1/sites/{site_id}

Request

Base URL
https://api.getsitecontrol.com
Auth
HTTP bearer

Path parameters

site_idinteger required

Response

Successful Response

idinteger required

namestring nullable

Name given in the admin; null when none was given

urlstring nullable

Address of the site

timezonestring nullable

IANA time zone name, e.g. Europe/Berlin; null when not set

is_suspendedboolean nullable

true: the site is suspended and widgets cannot be turned on (update_widgets refuses to turn one on); false: not suspended

is_script_installedboolean nullable

true: the Getsitecontrol script was found on the site, e.g. a widget was shown there; false: not found yet

created_atstring date-time nullable

updated_atstring date-time nullable

accessobject nullable

In list_sites: your level in each section of the site, widgets, emails and contacts: none, view (read), edit (change), full (also turn widgets on and send); a change needs edit or full

Example response

{
  "access": {
    "widgets": "edit",
    "emails": "edit",
    "contacts": "view"
  }
}

Changes

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