Searches mandates by geography (within a polygon or near a point) and optional filters. Returns offset-based pagination: `results`, `total`, `hasMore`, `offset`, `limit`. To stream the full mandate set incrementally, use `GET /api/v1/mandates` with a cursor instead.

Body·

required

Request body for searching mandates.

filters
Type: object · nullable

Optional filters for mandate search.
limit
Type: integer | string Pattern: ^-?(?:0|[1-9]\d*)$Format: int32
min:
1
max:
100

Maximum number of results to return per page. Range: 1-100. Defaults to 100.
near
Type: object · nullable

Point coordinates for near-field search on the mandates V1 routes. Shared by the PATCH update body, the POST create request, and the POST search request.
offset
Type: integer | string Pattern: ^-?(?:0|[1-9]\d*)$Format: int32
min:
0
max:
10000

Number of results to skip (for pagination). Maximum offset: 10,000.
radius
Type: null | integer | string Pattern: ^-?(?:0|[1-9]\d*)$Format: int32
within
nullable

Responses

application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json

post/api/v1/mandates/search

curl https://app.propstreet.com/api/v1/mandates/search \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "within": null,
  "near": {
    "longitude": null,
    "latitude": null
  },
  "radius": null,
  "filters": {
    "country": null,
    "categories": [
      ""
    ],
    "tags": [
      ""
    ],
    "name": null
  },
  "limit": 1,
  "offset": 0
}'

Show Schema

{
  "results": [
    {
      "id": "string",
      "uri": null,
      "name": "string",
      "description": null,
      "geography": null,
      "resolvedLocation": {
        "name": "string",
        "country": null,
        "longitude": null,
        "latitude": null
      },
      "country": null,
      "investmentSize": {
        "min": null,
        "max": null,
        "currency": "string",
        "scale": "string"
      },
      "yearBuilt": {
        "min": null,
        "max": null
      },
      "parcelArea": {
        "min": null,
        "max": null
      },
      "categories": [
        {
          "type": "string",
          "locationClasses": [
            "string"
          ],
          "yieldPercent": {
            "min": null,
            "max": null
          },
          "leasableUnits": {
            "min": null,
            "max": null
          },
          "vacancyRate": {
            "min": null,
            "max": null
          },
          "rentPerUnit": {
            "min": null,
            "max": null,
            "currency": "string",
            "scale": "string"
          }
        }
      ],
      "positiveTags": [
        "string"
      ],
      "negativeTags": [
        "string"
      ],
      "externalRefs": [
        {
          "namespace": "string",
          "id": "string"
        }
      ],
      "createdUtc": "2026-08-13T21:32:28.858Z",
      "updatedUtc": "2026-08-13T21:32:28.858Z",
      "deletedUtc": null,
      "etag": "string",
      "changeType": null,
      "changeOrigin": null
    }
  ],
  "total": 1,
  "hasMore": true,
  "offset": 1,
  "limit": 1
}