Lists mandates with cursor-based pagination and delta sync support.

Query Parameters

updated_since
Type: stringFormat: date-time

Filter mandates updated on or after this UTC timestamp (ISO 8601)
include_deleted
Type: boolean

Include deleted mandates in results
page_size
Type: integer | stringFormat: int32

Number of mandates per page (1-500)
cursor
Type: string

Opaque cursor token from previous response
country
Type: string

Filter by country (ISO 3166-1 alpha-2)
category
Type: string

Filter by category (e.g., 'office', 'retail/shopping_mall')
tags
Type: array of string

Filter by tags (repeatable, OR semantics)
name
Type: string

Free text search across mandate name and description

Responses

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

get/api/v1/mandates

curl 'https://app.propstreet.com/api/v1/mandates?include_deleted=false' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

Show Schema

{
  "data": [
    {
      "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-11-03T08:59:16.759Z",
      "updatedUtc": "2026-11-03T08:59:16.759Z",
      "deletedUtc": null,
      "etag": "string",
      "changeType": null,
      "changeOrigin": null
    }
  ],
  "page": {
    "nextCursor": null,
    "pageSize": 1,
    "hasMore": true
  }
}

Mandates

Creates a new mandate.