Templates List#
POST
/user-settings/templates/list
Request#
Example request#
curl -X POST 'https://api.pricehubble.com/api/v1/user-settings/templates/list' \
-H 'Authorization: Bearer 74126eab0a9048d993bda4b1b55ae074' \
-H 'Content-Type: application/json' \
-d '{
"countryCode": "CH"
}'
Request fields#
Field | Description | Type | Remarks |
---|---|---|---|
countryCode | ISO country code | string |
Response#
Example Response#
[
{
"uuid": "e1bb921e-7d77-4914-84b3-1529b22842e8",
"title": "My template",
"countryCode": "CH",
"level": "user",
"rentType": "rent_net",
"primaryColor": "#066ABE",
"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": {}
}
]
},
{
"uuid": "b4bb921e-7d77-4914-84b3-1529b22842e9",
"title": "CREATION_PDF.TEMPLATE_DEFAULT",
"countryCode": "CH",
"level": "pricehubble",
"rentType": "rent_net",
"primaryColor": "#08964D",
"frontCover": true,
"backCover": true,
"sections": [
{
"type": "overview",
"enabled": true,
"configuration": {
"layout": "brochure"
}
},
{
"type": "comparables",
"enabled": true,
"configuration": {
"offers": true,
"transactions": true,
"market_trends": true,
"offer_details": true,
"transaction_details": true
}
},
{
"type": "market",
"enabled": false,
"configuration": {}
},
{
"type": "socio",
"enabled": true,
"configuration": {
"economics": true,
"demographics": true
}
},
{
"type": "environment",
"enabled": true,
"configuration": {
"view": true,
"noise": true,
"nuisance": true
}
},
{
"type": "amenities",
"enabled": true,
"configuration": {
"health": true,
"leisure": true,
"catering": true,
"shopping": true,
"education": true
}
},
{
"type": "accessibility",
"enabled": true,
"configuration": {}
},
{
"type": "projects",
"enabled": true,
"configuration": {}
},
{
"type": "attachments.floorplan",
"enabled": true,
"configuration": {}
},
{
"type": "attachments.permit",
"enabled": true,
"configuration": {}
},
{
"type": "attachments.marketing",
"enabled": true,
"configuration": {}
},
{
"type": "attachments.valuation",
"enabled": true,
"configuration": {}
},
{
"type": "attachments.other",
"enabled": true,
"configuration": {}
}
]
}
]
Response fields#
The response is an array of all the templates visible by the user, see Template