PRODUCTION

This service will return the list of properties for the customer

Resource information
AuthenticationRequired
HTTP MethodGET
ResponseJSON
Version1

Resource URL

https://mapaprop.app/api/action/portal-v2/customers

Sample code

GET /api/action/portal-v2/customers?countyId=222&cityId=53&from=0&size=20&oauth_token=ya29.1.AADtN_UxybTdjLw9jX6lg_branSjjsldiwjtek4q2WvfETzSrz7Q6loEYoJEWd1x4qvlpGw. HTTP/1.1
Host: mapaprop.app
Content-Type: application/x-www-form-urlencoded
Content-Length: 0
Authorization: Bearer ya29.1.AADtN_UxybTdjLw9jX6lg_branSjjsldiwjtek4q2WvfETzSrz7Q6loEYoJEWd1x4qvlpGw

Parameters

KeyTypeRequiredDescription
termstringnoA term that will try to match at least 3 characters in name field of the customer. Full text search capabilities.
countryIdintnoThe countryID of the property
zone1intnoThe state ID of the property
zone2intnoThe county ID of the property
zone3intnoThe city ID of the property

Response

A JSON document with the list of zones in a hierarchy where the customer has properties.

ObjectFieldTypeRequiredDescription
ResponsetookintyesHow long the search took in milliseconds
totalintyesHow many total records are in the context of this search. You can paginate thru them
FiltersArray of filtersyesThe list of filters in url
customersArray of customersyesThe list of customer objects
CustomercustomerIdstringyesA unique ID for the customer
more data…stringyessome data

Sample response

{
  "took": 11,
  "total": 197,
  "filters": [...],
  "customers": [
    {
      "customerId": 123,
        ...
    }
  ]
}