List properties for a picker

POSThttp://localhost:4000/api/properties/getPropertiesDisplayList

Returns property titles and IDs, handy for dropdowns.

Your API key needs the properties.VIEW permission.

Body Params

searchValuestring

Only return properties whose title matches.

skipinteger

How many records to skip.

limitinteger

How many records to return.

Responses

200Successful response.

400The request is not valid.

401The API key is missing, invalid, expired or disabled.

403The API key does not have the permission this endpoint needs.

Language

Credentials

Bearer

Kept in this browser tab and sent only to the Estactics API. Requests act on your real data.

cURL Request

curl --request POST \
  --url http://localhost:4000/api/properties/getPropertiesDisplayList \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{"skip":0,"limit":10}'

Response

Click Try It! to send a request and see the response here, or choose an example: