# social.grain.unspecced.getSitemap

> One page of the public profiles or galleries a search engine may index, for the sitemap. Leaves out anything labeled, taken down, or in a space.

- Kind: query
- Authority: unspecced.grain.social
- Lexicon: 1
- Published by [grain.social](https://lexicon.garden/identity/did:plc:e7rftrdyz5e2rw4y6ocszew2), the NSID's authority

## Links

- [Documentation](https://lexicon.garden/lexicon/did:plc:e7rftrdyz5e2rw4y6ocszew2/social.grain.unspecced.getSitemap)
- [Schema JSON](https://lexicon.garden/lexicon/did:plc:e7rftrdyz5e2rw4y6ocszew2/social.grain.unspecced.getSitemap/schema.json)
- [Analytics](https://lexicon.garden/lexicon/did:plc:e7rftrdyz5e2rw4y6ocszew2/social.grain.unspecced.getSitemap/analytics)

## Query (`social.grain.unspecced.getSitemap`)

Type: query · GET

### Parameters (query string)

- `kind` (string, required)
  - Constraints: knownValues: profiles | galleries
- `page` (integer)
  - Constraints: minimum: 0, default: 0

### Output (application/json)

- `entries` (array, required)
  - `items` (ref)
    - Reference: `social.grain.unspecced.getSitemap#sitemapEntry`
- `pageCount` (integer, required): How many pages of this kind there are, so the sitemap index can list them all.

## #sitemapEntry (`social.grain.unspecced.getSitemap#sitemapEntry`)

Type: object

### Properties

- `lastmod` (string · datetime)
- `path` (string, required): The page's path on this site, named by handle where the account has one.

## Schema

```json
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "One page of the public profiles or galleries a search engine may index, for the sitemap. Leaves out anything labeled, taken down, or in a space.",
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "entries": {
              "items": {
                "ref": "social.grain.unspecced.getSitemap#sitemapEntry",
                "type": "ref"
              },
              "type": "array"
            },
            "pageCount": {
              "description": "How many pages of this kind there are, so the sitemap index can list them all.",
              "type": "integer"
            }
          },
          "required": [
            "entries",
            "pageCount"
          ],
          "type": "object"
        }
      },
      "parameters": {
        "properties": {
          "kind": {
            "knownValues": [
              "profiles",
              "galleries"
            ],
            "type": "string"
          },
          "page": {
            "default": 0,
            "minimum": 0,
            "type": "integer"
          }
        },
        "required": [
          "kind"
        ],
        "type": "params"
      },
      "type": "query"
    },
    "sitemapEntry": {
      "properties": {
        "lastmod": {
          "format": "datetime",
          "type": "string"
        },
        "path": {
          "description": "The page's path on this site, named by handle where the account has one.",
          "type": "string"
        }
      },
      "required": [
        "path"
      ],
      "type": "object"
    }
  },
  "id": "social.grain.unspecced.getSitemap",
  "lexicon": 1
}
```