Gets the teaser for a project.

​

Example

GET /api/v1/projects/42/teaser

Response shape

The DTO carries the broker-side superset: stage envelope, the options visibility matrix, the per-field template (allowed displays + tag pool), and the rendered investor projection. When the project has no property attached yet, only the stage envelope + a steerable nudge are returned.

Path Parameters
  • id
    Type: string
    required

    Project ID

Responses
  • application/json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
Request Example for get/api/v1/projects/{id}/teaser
curl 'https://app.propstreet.com/api/v1/projects/{id}/teaser' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

{
  "id": "string",
  "uri": null,
  "createdUtc": "2026-06-18T07:20:59.327Z",
  "updatedUtc": "2026-06-18T07:20:59.327Z",
  "etag": "string",
  "changeType": null,
  "changeOrigin": null,
  "stage": null,
  "publishedUtc": null,
  "verifiedUtc": null,
  "communicatedUtc": null,
  "isPreMarket": null,
  "exclusivity": null,
  "title": null,
  "tags": [
    "string"
  ],
  "options": {
    "locality": {
      "display": "actual"
    },
    "country": {
      "display": "actual"
    },
    "tenure": {
      "display": "actual"
    },
    "categories": {
      "display": "actual"
    },
    "parcelArea": {
      "display": "actual"
    },
    "avgContractLength": {
      "display": "actual"
    },
    "leasableUnits": {
      "display": "actual"
    },
    "zoningCategory": {
      "display": "actual"
    },
    "zoningGfa": {
      "display": "actual"
    },
    "rentalIncome": {
      "display": "actual"
    },
    "investmentSize": {
      "display": "actual"
    },
    "rentedPercent": {
      "display": "actual"
    },
    "totalCosts": {
      "display": "actual"
    },
    "noi": {
      "display": "actual"
    },
    "yield": {
      "display": "actual"
    },
    "propertyCount": {
      "display": "actual"
    },
    "conversions": {
      "display": "actual"
    },
    "yearBuilt": {
      "display": "actual"
    },
    "locationClasses": {
      "display": "actual"
    }
  },
  "template": {
    "locality": {
      "allowedDisplays": [
        "actual"
      ]
    },
    "country": {
      "allowedDisplays": [
        "actual"
      ]
    },
    "tenure": {
      "allowedDisplays": [
        "actual"
      ]
    },
    "categories": {
      "allowedDisplays": [
        "actual"
      ]
    },
    "parcelArea": {
      "allowedDisplays": [
        "actual"
      ]
    },
    "avgContractLength": {
      "allowedDisplays": [
        "actual"
      ]
    },
    "leasableUnits": {
      "allowedDisplays": [
        "actual"
      ]
    },
    "zoningCategory": {
      "allowedDisplays": [
        "actual"
      ]
    },
    "zoningGfa": {
      "allowedDisplays": [
        "actual"
      ]
    },
    "rentalIncome": {
      "allowedDisplays": [
        "actual"
      ]
    },
    "investmentSize": {
      "allowedDisplays": [
        "actual"
      ]
    },
    "rentedPercent": {
      "allowedDisplays": [
        "actual"
      ]
    },
    "totalCosts": {
      "allowedDisplays": [
        "actual"
      ]
    },
    "noi": {
      "allowedDisplays": [
        "actual"
      ]
    },
    "yield": {
      "allowedDisplays": [
        "actual"
      ]
    },
    "propertyCount": {
      "allowedDisplays": [
        "actual"
      ]
    },
    "conversions": {
      "allowedDisplays": [
        "actual"
      ]
    },
    "yearBuilt": {
      "allowedDisplays": [
        "actual"
      ]
    },
    "locationClasses": {
      "allowedDisplays": [
        "actual"
      ]
    },
    "tags": [
      "string"
    ]
  },
  "projection": {
    "locality": null,
    "country": null,
    "categories": [
      {
        "type": "string",
        "locationClass": null,
        "percentage": null
      }
    ],
    "yearBuilt": {
      "value": null,
      "min": null,
      "max": null
    },
    "tenure": null,
    "conversions": [
      "string"
    ],
    "rentalIncome": {
      "value": null,
      "min": null,
      "max": null,
      "currency": "string",
      "scale": "string"
    },
    "leasableUnits": {
      "value": null,
      "min": null,
      "max": null
    },
    "rentedPercent": {
      "value": null,
      "min": null,
      "max": null
    },
    "totalCosts": {
      "value": null,
      "min": null,
      "max": null,
      "currency": "string",
      "scale": "string"
    },
    "noi": {
      "value": null,
      "min": null,
      "max": null,
      "currency": "string",
      "scale": "string"
    },
    "parcelArea": {
      "value": null,
      "min": null,
      "max": null
    },
    "avgContractLength": {
      "value": null,
      "min": null,
      "max": null
    },
    "yield": {
      "value": null,
      "min": null,
      "max": null
    },
    "zoningCategories": [
      "string"
    ],
    "zoningGfa": {
      "value": null,
      "min": null,
      "max": null
    },
    "investmentSize": {
      "value": null,
      "min": null,
      "max": null,
      "currency": "string",
      "scale": "string"
    },
    "propertyCount": {
      "value": null,
      "min": null,
      "max": null
    }
  },
  "nudge": {
    "code": "string",
    "message": "string",
    "navigateUri": null
  },
  "navigateUri": null
}

Returns the project teaser.

Propstreet Documentation