Skip to content

Template Read#

GET user-settings/templates/<template_id>

Get the template specified in the request path.

Request#

curl -X GET 'https://api.pricehubble.com/api/v1/user-settings/templates/e1bb921e-7d77-4914-84b3-1529b22842e8' \
  -H 'Authorization: Bearer 74126eab0a9048d993bda4b1b55ae074' \
  -H 'Content-Type: application/json'

Response#

Example response#

{
    {
        "title": "My template",
        "countryCode": "CH",
        "level": "user",
        "rentType": "rent_net",
        "frontCover": true,
        "backCover": false,
        "sections": [
          {
            "type": "overview",
            "enabled": true,
            "configuration": {
                "layout": "brochure"
            }
          },
          {
            "type": "comparables",
            "enabled": true,
            "configuration": {
                "offers": false,
                "transactions": true,
                "market_trends": false,
                "offer_details": true,
                "transaction_details": true
            }
          },
          {
            "type": "market",
            "enabled": true,
            "configuration": {}
          },
          {
            "type": "socio",
            "enabled": true,
            "configuration": {
                "economics": false,
                "demographics": true
            }
          },
          {
            "type": "environment",
            "enabled": true,
            "configuration": {
                "view": true,
                "noise": true,
                "nuisance": true
            }
          },
          {
            "type": "amenities",
            "enabled": true,
            "configuration": {
                "health": false,
                "leisure": true,
                "catering": true,
                "shopping": true,
                "education": true
            }
          },
          {
            "type": "accessibility",
            "enabled": false,
            "configuration": {}
          },
          {
            "type": "projects",
            "enabled": true,
            "configuration": {}
          },
          {
            "type": "attachments.floorplan",
            "enabled": true,
            "configuration": {}
          },
          {
            "type": "attachments.permit",
            "enabled": false,
            "configuration": {}
          },
          {
            "type": "attachments.marketing",
            "enabled": true,
            "configuration": {}
          },
          {
            "type": "attachments.valuation",
            "enabled": true,
            "configuration": {}
          },
          {
            "type": "attachments.other",
            "enabled": true,
            "configuration": {}
          }
        ]
    }
}

Response fields#

Field Description Type Remarks
title The title of the template string
level The visibility level of the template string user or organization. organization-level Templates are visible by anyone in the organization, while user-level Templates are only visible by the creator.
countryCode ISO country code string
rentType Rent type to use if the PDF printed contains rent valuations string rent_net or rent_gross.
frontCover Whether to display a front cover or not boolean
backCover Whether to display a back cover or not boolean
sections Order and visibility of sections Array of Sections