Lists

Verified lists are collections a destination publisher has reviewed and made available on its map. Set BASE_URL as shown in the API overview before running these examples.

List verified lists

GET /maps/:map_id/lists

Returns verified lists for a map. Results can be selected with a start and end offset.

Parameter	In	Required	Description
map_id	Path	Yes	Map UUID.
verified	Query	No	Defaults to true. Only verified lists are publicly available.
start	Query	No	Start offset for the result window.
end	Query	No	End offset for the result window.

Caution

Requests with verified=false require publisher credentials and are not available through the public API.

curl --get "$BASE_URL/maps/11111111-1111-4111-8111-111111111111/lists" \
  --data-urlencode "verified=true" \
  --data-urlencode "start=0" \
  --data-urlencode "end=19"

Get a list

GET /maps/:map_id/lists/:list_id

Returns one list and its associated content within a map.

Parameter	In	Required	Description
map_id	Path	Yes	Map UUID.
list_id	Path	Yes	List UUID.

curl "$BASE_URL/maps/11111111-1111-4111-8111-111111111111/lists/44444444-4444-4444-8444-444444444444"