This service is the general configuration of the site and customer by a domain.
If what you are after is the design —colors, typography, logo, favicon, slides, calls to action, social networks—, use GET /api/action/express-v1/design. There it arrives grouped by section and with the images already resolved as URLs. The design also travels here, but mixed with the rest of the configuration and using Mapaprop's internal naming.
| Resource information | |
|---|---|
| Authentication | Required (API Token, Bearer) |
| Scope | express-base |
| HTTP Method | GET |
| Response | JSON |
| Version | 1 |
Resource URL
https://mapaprop.app/api/action/express-v1/settings-v2
Sample code
GET /api/action/express-v1/settings-v2 HTTP/1.1
Host: mapaprop.app
Content-Type: application/x-www-form-urlencoded
Content-Length: 0
Authorization: Bearer {access_token}
Response
A JSON document with the configuration of the customer and website.
| Object | Field | Type | Required | Description |
|---|---|---|---|---|
| Response | settings | Array of Setting | yes | The list of Setting object |
| customer | Customer | yes | The customer object | |
| Setting | name | string | yes | The name of the setting |
| category | string | yes | The category it belongs to (see the category table below) | |
| value | string | yes | The configured value. It may arrive empty if the customer did not set it | |
| custId | number | yes | The account identifier | |
| websiteId | number | yes | The site identifier | |
| Customer | name | string | yes | The company name of the realtor |
| address | string | yes | The address of the realtor | |
| zone0Description | string | yes | The country where the realtor is located | |
| zone1Description | string | yes | The state / province the realtor is located | |
| zone2Description | string | yes | The county the realtor is located / neighborhood in some cases | |
| zone3Description | string | no | The city the realtor is located | |
| zip | string | yes | The zip code of the realtor | |
| websiteActive | boolean | yes | If the website is active or not. If not, no other service will bring you data. This might be because the customer is overdue with bills or simple cancellation | |
| phone1 | string | yes | A phone number of the realtor | |
| phone2 | string | no | An alternative phone number for the realtor | |
| phone3 | string | no | An alternative phone number for the realtor | |
| mobile | string | no | Mobile phone number for instant messengers | |
| string | yes | The email of the customer |
The categories
Every setting arrives with the category it belongs to. These are the ones you will find:
| Category | What it carries |
|---|---|
config | General behaviour of the site (for example, the branch mode) |
resource | Site resources: stylesheet, template path, images, Google Analytics code, Meta pixel |
desing | Design: colors, typography, calls to action and the footer contact person. The category name is missing the g: it is historical and arrives that way |
social | The real estate agency's social networks |
branch | Configuration tied to the branches |
mapbox | Map configuration |
reCaptchaV3 | The public site key (site.key), the one you need to render the widget |
features | Features enabled on the site |
chat.ai | Configuration of the artificial intelligence chat |
The list of settings is not fixed: it grows as configuration options are added, and each account only brings what it configured. Walk the list looking for the name you care about instead of assuming positions or a given number of elements.
The private reCAPTCHA key is not returned and is not needed: we validate the token on our server side when the visitor submits the form with POST /api/action/express-v1/messages.
Sample response
{
"settings": [
{
"name": "mode",
"custId": 2230,
"websiteId": 6001,
"category": "config",
"value": "some.branches"
},
{
"name": "google.analytics",
"custId": 2230,
"websiteId": 6001,
"category": "resource",
"value": "UA-16637317-1"
},
{
"name": "logo",
"custId": 2230,
"websiteId": 6001,
"category": "resource",
"value": "/styles/customers/1687/logo.png"
},
{
"name": "path",
"custId": 2230,
"websiteId": 6001,
"category": "resource",
"value": "1687"
},
{
"name": "slide1.image",
"custId": 2230,
"websiteId": 6001,
"category": "resource",
"value": "/styles/customers/1687/slide1.jpg"
},
{
"name": "slide1.url",
"custId": 2230,
"websiteId": 6001,
"category": "resource",
"value": "/contacto"
},
{
"name": "slide2.image",
"custId": 2230,
"websiteId": 6001,
"category": "resource",
"value": "/styles/customers/1687/slide2.jpg"
},
{
"name": "slide2.url",
"custId": 2230,
"websiteId": 6001,
"category": "resource",
"value": "/contacto"
},
{
"name": "slide3.image",
"custId": 2230,
"websiteId": 6001,
"category": "resource",
"value": "/styles/customers/1687/slide3.jpg"
},
{
"name": "slide3.url",
"custId": 2230,
"websiteId": 6001,
"category": "resource",
"value": "/contacto"
},
{
"name": "stylesheet",
"custId": 2230,
"websiteId": 6001,
"category": "resource",
"value": "/styles/customers/1687/style.css"
}
],
"customer": {
"name": "Super Realtors Inc",
"tempRental": true,
"zone0Description": "Argentina",
"zone1Description": "Capital Federal",
"zone2Description": "Recoleta",
"websiteActive": true,
"phone1": "2334-3322",
"phone2": "2334-3323",
"mobile": "541122226666",
"email": "info@fancy.com",
"zip": "1425",
"address": "Skype: apartments"
}
}