API Playground - list_sites

list_sites


Returns sites defined in a Planyo meta site along with additional information and photos. You can specify a site filter. (click for full documentation)

detail_level

Sum of one or more of the following integers (ORed value): 1=site name, 2=site settings, 4=custom site properties, 8=resource photos, 16=extension usage. Default value is 1 (name only).

page

Zero-based page number. The default is 0. Max. number of results per page is defined by by default 100. Note: you can change the page size (max 500) with the page_size parameter.

admin_id

You can optionally filter the sites returned by the ID of the main site administrator. When this parameter is skipped, all sites will be returned.

filter_name

Optional filter name (in form: prop_cal_xxx, see Q206 for the full list of site filters available for your Planyo site). Together with filter_value, these parameters work just just the site filter in advanced integration and let you only get a subset of sites.

filter_value

Exact value of the custom site property to be used together with filter_name as the site filter. Note: instead of using this parameter, you can also use filter_value_inc which looks for values of the custom site property which include the requested text. Using filter_value will only find exact matches.

ppp_gps_coords_radius

If you want to use a geolocation filter (see Q281 for more about this), you must pass the distance from a point using this parameter (use the 'm' suffix to indicate if the distance is in miles, for kilometers use the 'km' suffix or no suffix at all, just a float) and you should set the coordinates of the search point (latitude followed by a comma and then longitude in decimal degrees, e.g. 46.17,8.80) using the parameter prop_cal_gps_coords. Only the results within specified distance from the given point will be returned. Additionally the distance in kilometers will be returned for each site ('distance' key).

sort

Sort criterium. Currently you can only use the value 'prop_cal_gps_coords' (when using ppp_gps_coords_radius) or leave the value empty to have sites ordered by name.

language

by specifying a 2-letter (ISO 639-1) language code (all capital letters e.g. EN, DE, FR, ES, IT) you can change the language of the text values returned

api_key

your API key - Click here to get your key
* - Pflichtfeld