---
title: "Sitemap — Properties"
method: GET
path: "/sitemap/properties"
tags: ["Sitemap"]
---

# Sitemap — Properties

`GET /sitemap/properties`

## Request

- Base URL: `https://api.purplegrain.com/api/v1`
- URL: `https://api.purplegrain.com/api/v1/sitemap/properties`
- Auth: none declared

Cursor-paginated list of publicly indexable properties, with the active paddocks and mobs on each (design handoff 22).
Only properties whose visibility is `public` appear: a property shared by link or kept private is never listed, and its pages say `noindex`.
Items carry the address under the web app (`/organizations/{org}/properties/{property}[/paddocks/{paddock}|/mobs/{mob}]`).
No authentication required.

## Query parameters

- `cursor` string
- `limit` integer

## Response `200`

Paginated list of indexable property, paddock and mob paths.

- SitemapPropertiesResponse
  - `items` SitemapPathItem[], required
    - `path` string, required: The address under the web app, e.g. `/organizations/hillcrest/properties/yarrabee`.
    - `lastmod` string, date-time, nullable, required
    - `indexable` boolean, required
  - `next_cursor` string, nullable, required
  - `total` integer, required: The number of public properties (the cursor pages over properties; each page also carries their paddocks and mobs).

---

[API](https://skmtc.dev/purplegrain/apis/purple-grain-api.md) · [All operations](https://skmtc.dev/purplegrain/apis/purple-grain-api/llms.txt) · [OpenAPI document](https://skmtc.dev/purplegrain/apis/purple-grain-api/revisions/a9136f78e9fb?raw)