Skip to content
GetsitecontrolDevelopers

Get a site

GET
https://api.getsitecontrol.com/v1/sites/{site_id}
curl --request GET \
  --url https://api.getsitecontrol.com/v1/sites/1 \
  --header 'Authorization: Bearer <token>'

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.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
FieldDescription
site_id
required
Site Id
integer

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
Site
object
FieldDescription
id
required
Id
integer
name
Name

Name given in the admin; null when none was given

string
nullable
url
Url

Address of the site

string
nullable
timezone
Timezone

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

string
nullable
is_suspended
Is Suspended

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

boolean
nullable
is_script_installed
Is Script Installed

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

boolean
nullable
created_at
Created At
string format: date-time
nullable
updated_at
Updated At
string format: date-time
nullable
access
Access

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

object
FieldDescription
key
additional properties
string

Example 

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

Headers

Section titled “Headers”
FieldDescription
GSC-Version
string

API version the response was produced for

X-Request-Id
string

Request id, echoed from the request when valid

X-RateLimit-Limit
integer

Limit of the tightest bucket

X-RateLimit-Remaining
integer

Requests left in its window

X-RateLimit-Reset
integer

End of its window, epoch seconds

400

Section titled “400”

Unsupported GSC-Version

Media typeapplication/problem+json
Problem

The documented shape of every error body on the versioned surface.

object
FieldDescription
type
required
Type
string
title
required
Title
string
status
required
Status
integer
detail
Detail
string
nullable
instance
required
Instance
string
reason
Reason
string
nullable
next
Next
string
nullable
request_id
required
Request Id
string
errors
Errors
Array<object>
nullable
ValidationIssue
object
FieldDescription
loc
required
Loc
Array
msg
required
Msg
string
type
required
Type
string
metadata
Metadata
object

Example · Generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "reason": "example",
  "next": "example",
  "request_id": "example",
  "errors": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ],
  "metadata": {}
}

Headers

Section titled “Headers”
FieldDescription
GSC-Version
string

API version the response was produced for

X-Request-Id
string

Request id, echoed from the request when valid

X-RateLimit-Limit
integer

Limit of the tightest bucket

X-RateLimit-Remaining
integer

Requests left in its window

X-RateLimit-Reset
integer

End of its window, epoch seconds

401

Section titled “401”

Missing or invalid API key or access token

Media typeapplication/problem+json
Problem

The documented shape of every error body on the versioned surface.

object
FieldDescription
type
required
Type
string
title
required
Title
string
status
required
Status
integer
detail
Detail
string
nullable
instance
required
Instance
string
reason
Reason
string
nullable
next
Next
string
nullable
request_id
required
Request Id
string
errors
Errors
Array<object>
nullable
ValidationIssue
object
FieldDescription
loc
required
Loc
Array
msg
required
Msg
string
type
required
Type
string
metadata
Metadata
object

Example · Generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "reason": "example",
  "next": "example",
  "request_id": "example",
  "errors": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ],
  "metadata": {}
}

Headers

Section titled “Headers”
FieldDescription
GSC-Version
string

API version the response was produced for

X-Request-Id
string

Request id, echoed from the request when valid

X-RateLimit-Limit
integer

Limit of the tightest bucket

X-RateLimit-Remaining
integer

Requests left in its window

X-RateLimit-Reset
integer

End of its window, epoch seconds

WWW-Authenticate
string

Authentication scheme: Bearer

403

Section titled “403”

Access denied

Media typeapplication/problem+json
Problem

The documented shape of every error body on the versioned surface.

object
FieldDescription
type
required
Type
string
title
required
Title
string
status
required
Status
integer
detail
Detail
string
nullable
instance
required
Instance
string
reason
Reason
string
nullable
next
Next
string
nullable
request_id
required
Request Id
string
errors
Errors
Array<object>
nullable
ValidationIssue
object
FieldDescription
loc
required
Loc
Array
msg
required
Msg
string
type
required
Type
string
metadata
Metadata
object

Example · Generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "reason": "example",
  "next": "example",
  "request_id": "example",
  "errors": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ],
  "metadata": {}
}

Headers

Section titled “Headers”
FieldDescription
GSC-Version
string

API version the response was produced for

X-Request-Id
string

Request id, echoed from the request when valid

X-RateLimit-Limit
integer

Limit of the tightest bucket

X-RateLimit-Remaining
integer

Requests left in its window

X-RateLimit-Reset
integer

End of its window, epoch seconds

404

Section titled “404”

site_not_found: no such site, it is deleted, or it belongs to another account

Media typeapplication/problem+json
Problem

The documented shape of every error body on the versioned surface.

object
FieldDescription
type
required
Type
string
title
required
Title
string
status
required
Status
integer
detail
Detail
string
nullable
instance
required
Instance
string
reason
Reason
string
nullable
next
Next
string
nullable
request_id
required
Request Id
string
errors
Errors
Array<object>
nullable
ValidationIssue
object
FieldDescription
loc
required
Loc
Array
msg
required
Msg
string
type
required
Type
string
metadata
Metadata
object

Example · Generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "reason": "example",
  "next": "example",
  "request_id": "example",
  "errors": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ],
  "metadata": {}
}

Headers

Section titled “Headers”
FieldDescription
GSC-Version
string

API version the response was produced for

X-Request-Id
string

Request id, echoed from the request when valid

X-RateLimit-Limit
integer

Limit of the tightest bucket

X-RateLimit-Remaining
integer

Requests left in its window

X-RateLimit-Reset
integer

End of its window, epoch seconds

422

Section titled “422”

Validation failed

Media typeapplication/problem+json
Problem

The documented shape of every error body on the versioned surface.

object
FieldDescription
type
required
Type
string
title
required
Title
string
status
required
Status
integer
detail
Detail
string
nullable
instance
required
Instance
string
reason
Reason
string
nullable
next
Next
string
nullable
request_id
required
Request Id
string
errors
Errors
Array<object>
nullable
ValidationIssue
object
FieldDescription
loc
required
Loc
Array
msg
required
Msg
string
type
required
Type
string
metadata
Metadata
object

Example · Generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "reason": "example",
  "next": "example",
  "request_id": "example",
  "errors": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ],
  "metadata": {}
}

Headers

Section titled “Headers”
FieldDescription
GSC-Version
string

API version the response was produced for

X-Request-Id
string

Request id, echoed from the request when valid

X-RateLimit-Limit
integer

Limit of the tightest bucket

X-RateLimit-Remaining
integer

Requests left in its window

X-RateLimit-Reset
integer

End of its window, epoch seconds

429

Section titled “429”

Rate limited

Media typeapplication/problem+json
Problem

The documented shape of every error body on the versioned surface.

object
FieldDescription
type
required
Type
string
title
required
Title
string
status
required
Status
integer
detail
Detail
string
nullable
instance
required
Instance
string
reason
Reason
string
nullable
next
Next
string
nullable
request_id
required
Request Id
string
errors
Errors
Array<object>
nullable
ValidationIssue
object
FieldDescription
loc
required
Loc
Array
msg
required
Msg
string
type
required
Type
string
metadata
Metadata
object

Example · Generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "reason": "example",
  "next": "example",
  "request_id": "example",
  "errors": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ],
  "metadata": {}
}

Headers

Section titled “Headers”
FieldDescription
GSC-Version
string

API version the response was produced for

X-Request-Id
string

Request id, echoed from the request when valid

X-RateLimit-Limit
integer

Limit of the tightest bucket

X-RateLimit-Remaining
integer

Requests left in its window

X-RateLimit-Reset
integer

End of its window, epoch seconds

Retry-After
integer

Seconds until the bucket refills

503

Section titled “503”

Temporarily unavailable; retry later

Media typeapplication/problem+json
Problem

The documented shape of every error body on the versioned surface.

object
FieldDescription
type
required
Type
string
title
required
Title
string
status
required
Status
integer
detail
Detail
string
nullable
instance
required
Instance
string
reason
Reason
string
nullable
next
Next
string
nullable
request_id
required
Request Id
string
errors
Errors
Array<object>
nullable
ValidationIssue
object
FieldDescription
loc
required
Loc
Array
msg
required
Msg
string
type
required
Type
string
metadata
Metadata
object

Example · Generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "reason": "example",
  "next": "example",
  "request_id": "example",
  "errors": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ],
  "metadata": {}
}

Headers

Section titled “Headers”
FieldDescription
GSC-Version
string

API version the response was produced for

X-Request-Id
string

Request id, echoed from the request when valid

X-RateLimit-Limit
integer

Limit of the tightest bucket

X-RateLimit-Remaining
integer

Requests left in its window

X-RateLimit-Reset
integer

End of its window, epoch seconds

llms.txtOpenAPI