List the websites tracked in this workspace.

Start here. Returns every website the caller may see, with its Search Console binding. A site without gsc_property_url cannot run reports or import history; tell the user to connect Search Console in the dashboard.

GEThttps://app.softsolz.uk/api/v1/services/seo/sites

Recent Requests

TimeStatusUser Agent

Make a request to see history.

Headers

Authorizationstringrequired

Bearer token: `Bearer sk_live_...` (or `sk_test_...` for sandbox). A login token will not work here.

Query Params

limitinteger

Page size, 1 to 200 (default 50).

offsetinteger

Rows to skip before the first result.

Response

Response Body · array of objects

idstringWebsite id. Use it as site_id in every other call.

namestringDisplay name.

domainstringBare domain the site is tracked under.

gsc_property_urlstring | nullSearch Console property bound to this site, or null when not connected. Reports and history imports need this.

gsc_connection_idstring | nullGoogle connection carrying the property.

timezonestringIANA timezone used for reporting.

statusstringactive, paused or archived.

refresh_frequencystringdaily, weekly or monthly automatic refresh.

last_refresh_atstring | nullWhen Search Console data was last refreshed.

settings_jsonobjectBrand terms, thresholds and caps that tune the detectors.

visibilitystringprivate, tenant or shared. A plain API key only sees tenant-wide sites; a connected app sees what its member sees.

created_byinteger | nullMember who added the site.

created_atstringCreation time.

updated_atstringRound-trip as expected_updated_at on PATCH to avoid overwriting a newer edit.

Request

import { SoftSolz } from '@softsolz/sdk';

const client = new SoftSolz({ apiKey: process.env.SOFTSOLZ_API_KEY });

const result = await client.seo.listSites({});
console.log(result);

Credentials

Authorization

Sent as a Bearer token. Stored only in your browser.

Response · 200

{
  "data": [
    {
      "id": "string",
      "name": "string",
      "domain": "string",
      "gsc_property_url": "string",
      "gsc_connection_id": "string",
      "timezone": "string",
      "status": "string",
      "refresh_frequency": "string",
      "last_refresh_at": "string",
      "settings_json": {},
      "visibility": "string",
      "created_by": 0,
      "created_at": "string",
      "updated_at": "string"
    }
  ]
}