Sitemap

Sitemap — Properties

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.

get/sitemap/properties

Request

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

Query parameters

cursorstring

Opaque pagination cursor from the previous page's next_cursor field.

limitinteger

Maximum number of properties to return (default 5000, max 10000).

Response

Paginated list of indexable property, paddock and mob paths.

next_cursorstring nullable required
totalinteger required

The number of public properties (the cursor pages over properties; each page also carries their paddocks and mobs).

Changes

No recorded changes to this operation across all 2 revisions of this API.