# Search Console Sitemaps (`search-console.sitemaps`)

Lists the sitemaps submitted for a Search Console property with their status, last download, error counts and URLs submitted.

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

- Endpoint: `POST https://api.primaryapi.com/v1/run/search-console.sitemaps`
- 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.sitemaps`
- Execution: synchronous (answers 202 only if it outlives the wait window)

## Input

| Field | Type | Required | Default | Constraints | Description |
|---|---|---|---|---|---|
| `siteUrl` | string | yes |  | max 2048 chars | The Search Console property, exactly as search-console.sites lists it: "sc-domain:example.com" for a Domain property, or a URL-prefix property with its trailing slash, e.g. "https://www.example.com/". |
| `sitemapIndex` | string | no |  | max 2048 chars | Optional URL of a sitemap index inside siteUrl: lists the sitemaps it contains instead of the ones submitted for the site. |
| `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 |
|---|---|---|
| `sitemaps` | object[] |  |
| `sitemaps[].url` | string | The sitemap URL (Search Console calls it path) |
| `sitemaps[].type` | string \| null | sitemap, rssFeed, atomFeed, urlList, patternSitemap or notSitemap |
| `sitemaps[].isIndex` | boolean | True for a sitemap index (a list of sitemaps) |
| `sitemaps[].isPending` | boolean | True while Google has not processed it yet |
| `sitemaps[].lastSubmitted` | string \| null |  |
| `sitemaps[].lastDownloaded` | string \| null |  |
| `sitemaps[].warnings` | integer \| null |  |
| `sitemaps[].errors` | integer \| null | Problems with the sitemap itself that stop it being processed |
| `sitemaps[].contents` | object[] |  |
| `sitemaps[].contents[].type` | string \| null | web, image, video, news, mobile, androidApp, iosApp or pattern |
| `sitemaps[].contents[].submitted` | integer \| null | URLs of this type listed in the sitemap |
| `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

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

## 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": {
      "sitemaps": [
        {
          "url": "https://www.example.com/sitemap.xml",
          "type": "sitemap",
          "isIndex": false,
          "isPending": false,
          "lastSubmitted": "2026-11-01T09:12:44.512Z",
          "lastDownloaded": "2026-11-15T21:03:10.118Z",
          "warnings": 0,
          "errors": 0,
          "contents": [
            {
              "type": "web",
              "submitted": 1284
            }
          ]
        }
      ],
      "nextCursor": null
    }
  },
  "provider": "PrimaryAPI",
  "credits": 1,
  "items": 1,
  "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.sitemaps`

## 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). Submit or remove sitemaps with search-console.submit_sitemap and search-console.delete_sitemap. A property the account cannot see is a miss with reason no_access.

