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 as an array, each with a stop_count. Send both start and end to page through them: the response is then { results, total }.

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.

curl --get "$BASE_URL/maps/c2025939-af64-4371-a281-c6818b2cd96e/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. A list ID that isn’t on the map returns 200 with an empty body, not 404, so check for an empty response.

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

curl "$BASE_URL/maps/c2025939-af64-4371-a281-c6818b2cd96e/lists/8c84e17d-a8fb-43d2-bcd6-51b6d6e97fb5"