# Search Console Properties (`search-console.sites`)

Lists the Search Console properties of the connected Google account with its permission level on each one.

Docs: https://primaryapi.com/docs/api-reference/search-console/sites

- Endpoint: `POST https://api.primaryapi.com/v1/run/search-console.sites`
- Category: Search & SEO · Platform: `search-console` · Kind: list · Status: live
- Price: 1 credit per call. Every call costs the same, including calls that were retried automatically.
- Billing unit: per successful call
- Reliability: routed to a healthy upstream and retried automatically when an attempt fails; live 30-day status: `GET https://api.primaryapi.com/v1/status/apis?sku=search-console.sites`
- Execution: synchronous (answers 202 only if it outlives the wait window)

## Input

| Field | Type | Required | Default | Constraints | Description |
|---|---|---|---|---|---|
| `connection` | string | no |  | max 200 chars | Which connected account to use when the workspace has several for this provider: the customId you gave it (exact), its connection id ("con_…"), its handle (login, email or @handle) or its name. Optional; prefer the customId or id, which never match two accounts. |

Unknown fields are rejected with `400 invalid_input`. The routing controls `preferLatencyUnderMs` and `maxCredits` may be sent in the same JSON body.

## Output

When `output.found` is `true`, `output.data` has this shape:

| Field | Type | Description |
|---|---|---|
| `sites` | object[] |  |
| `sites[].siteUrl` | string | Property id to pass as siteUrl: "sc-domain:example.com" or "https://www.example.com/" |
| `sites[].propertyType` | enum | Domain property (sc-domain:) or URL-prefix property |
| `sites[].permissionLevel` | string \| null | siteOwner, siteFullUser, siteRestrictedUser or siteUnverifiedUser |
| `sites[].verified` | boolean | False for siteUnverifiedUser: the account added the property but has not verified it |
| `nextCursor` | string \| null |  |

When the thing you asked about does not exist (or a search matches nothing) the call still succeeds: `output.found` is `false`, `output.data` is `null` and `output.reason` says why (`not_found`, `private`, `no_results`, …). Misses are free unless the notes below say misses are billed.

## Example request

_Input values are placeholders built from the schema._

```bash
curl -sS -X POST "https://api.primaryapi.com/v1/run/search-console.sites" \
  -H "Authorization: Bearer $PRIMARYAPI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```

## Example response

_Values are placeholders that follow the output schema; `credits` is what this call would cost at the usual price._

```json
{
  "output": {
    "found": true,
    "data": {
      "sites": [
        {
          "siteUrl": "sc-domain:example.com",
          "propertyType": "domain",
          "permissionLevel": "siteOwner",
          "verified": true
        },
        {
          "siteUrl": "https://blog.example.com/",
          "propertyType": "url_prefix",
          "permissionLevel": "siteFullUser",
          "verified": true
        },
        {
          "siteUrl": "https://shop.example.org/",
          "propertyType": "url_prefix",
          "permissionLevel": "siteUnverifiedUser",
          "verified": false
        }
      ],
      "nextCursor": null
    }
  },
  "provider": "PrimaryAPI",
  "credits": 1,
  "items": 3,
  "requestId": "req_01JBXK6Y2N9V8T4R3Q2P1M0A7Z",
  "nextCursor": null
}
```

## Pricing and reliability

- Usual price: 1 credit per call
- Price ceiling: the usual price, even when a call is retried. A quote’s `maxCredits` is the most a given call can cost; the `maxCredits` routing control caps it per call
- Live 30-day status, success rate, uptime and latency: `GET https://api.primaryapi.com/v1/status/apis?sku=search-console.sites`

## Errors to handle

`invalid_input`, `unauthorized`, `insufficient_balance`, `key_limit_reached`, `trial_cap_reached`, `forbidden`, `not_found`, `idempotency_conflict`, `rate_limited`, `all_sources_failed`, `service_unavailable`, `timeout`. See https://primaryapi.com/docs/errors.

## Notes

Runs as your connected Google account and needs the Read Search Console capability (search_console_read). Use the siteUrl values exactly as listed (Domain properties start with "sc-domain:", URL-prefix properties end with a slash) in search-console.performance, search-console.inspect_url and search-console.sitemaps.

