GET /api/action/portal-v2/customers

PROD

This service returns the list of customers (real estate agencies) of the portal. Supports text search, geographic filters and pagination. Only active and verified customers are returned.

If your client has the network-suscription scope, results are restricted to the customers of your network. Otherwise the search runs across all customers.

Resource information
Authentication	Required
Scope	`internal-portal`
HTTP Method	GET
Response	JSON
Version	2

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 HTTP/1.1
Host: mapaprop.app
Content-Type: application/x-www-form-urlencoded
Content-Length: 0
Authorization: Bearer {access_token}

Parameters

Key	Type	Required	Description
term	string	no	A term that will try to match at least 3 characters in the `name` field of the customer. Full text search capabilities.
from	int	no	Pagination start index. Default 0
size	int	no	Number of results to return. Default 20
countryId	int	no	Country ID filter. Constants
stateId	int	no	State / province ID filter
countyId	int	no	County ID filter
cityId	int	no	City ID filter

Response

A JSON document with the list of customers matching the filters.

Object	Field	Type	Required	Description
Response	took	int	yes	How long the search took in milliseconds
	total	int	yes	How many total records are in the context of this search. You can paginate thru them
	filters	Object	yes	The filters applied to the search (includes a `country` object with id and description when a country filter was used, and `term` when text search was used)
	customers	Array of customers	yes	The list of customer objects. Each customer includes the public profile of the agency: id, name, logo, address, zone information and contact data

Sample response

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