List the connected account's properties

GET

/v1/sites/{id}/gsc/properties

curl --request GET \
  --url https://api.overwatch.weareheavy.dev/v1/sites/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/gsc/properties \
  --header 'x-api-key: <x-api-key>'

• Production

Live from the Search Console API. suggested marks properties whose host matches the site (domain properties preferred). Owner/admin only.

Authorizations

• ApiKeyAuth
• BearerAuth

Parameters

Path Parameters

id

required

string format: uuid

The site’s UUID.

Responses

200

Properties, suggested matches first.

Media typeapplication/json

object

properties

required

Array<object>

object

siteUrl

required

‘https://example.com/’ (URL-prefix) or ‘sc-domain:example.com’.

string

permissionLevel

required

string

suggested

required

boolean

Example^generated

{
  "properties": [
    {
      "siteUrl": "example",
      "permissionLevel": "example",
      "suggested": true
    }
  ]
}

401

Missing or invalid credentials.

Media typeapplication/json

object

error

required

A human-readable error message.

string

Example

{
  "error": "invalid api key"
}

404

Site not found, SEO app off, or not connected.

Media typeapplication/json

object

error

required

A human-readable error message.

string

Example^generated

{
  "error": "example"
}

409

Google access was revoked - reconnect.

Media typeapplication/json

object

error

required

A human-readable error message.

string

Example^generated

{
  "error": "example"
}