LocationServices_LocationManagement_GetLists
curl --request POST \
--url 'https://api.addressy.com/LocationServices/LocationManagement/GetLists/v1.10/json6.ws?Key=' \
--header 'Content-Type: application/json' \
--data '
{
"Key": "AA11-AA11-AA11-AA11",
"listId": "<string>"
}
'import requests
url = "https://api.addressy.com/LocationServices/LocationManagement/GetLists/v1.10/json6.ws?Key="
payload = {
"Key": "AA11-AA11-AA11-AA11",
"listId": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({Key: 'AA11-AA11-AA11-AA11', listId: '<string>'})
};
fetch('https://api.addressy.com/LocationServices/LocationManagement/GetLists/v1.10/json6.ws?Key=', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.addressy.com/LocationServices/LocationManagement/GetLists/v1.10/json6.ws?Key=",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'Key' => 'AA11-AA11-AA11-AA11',
'listId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.addressy.com/LocationServices/LocationManagement/GetLists/v1.10/json6.ws?Key="
payload := strings.NewReader("{\n \"Key\": \"AA11-AA11-AA11-AA11\",\n \"listId\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.addressy.com/LocationServices/LocationManagement/GetLists/v1.10/json6.ws?Key=")
.header("Content-Type", "application/json")
.body("{\n \"Key\": \"AA11-AA11-AA11-AA11\",\n \"listId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.addressy.com/LocationServices/LocationManagement/GetLists/v1.10/json6.ws?Key=")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"Key\": \"AA11-AA11-AA11-AA11\",\n \"listId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body[
{
"ListId": "<string>",
"ListName": "<string>",
"LatestRelatedListId": "<string>",
"IsErrorList": true,
"ListDescription": "<string>",
"Locations": [
{
"Id": "<string>",
"Name": "<string>",
"Description": "<string>",
"Address": "<string>",
"Country": "<string>",
"Latitude": "<string>",
"Longitude": "<string>",
"MetaInfo": {},
"UnstructuredMetaInfo": {},
"OpeningHours": {
"Monday": {
"Open": "<string>",
"Close": "<string>",
"Information": "<string>"
},
"Tuesday": {
"Open": "<string>",
"Close": "<string>",
"Information": "<string>"
},
"Wednesday": {
"Open": "<string>",
"Close": "<string>",
"Information": "<string>"
},
"Thursday": {
"Open": "<string>",
"Close": "<string>",
"Information": "<string>"
},
"Friday": {
"Open": "<string>",
"Close": "<string>",
"Information": "<string>"
},
"Saturday": {
"Open": "<string>",
"Close": "<string>",
"Information": "<string>"
},
"Sunday": {
"Open": "<string>",
"Close": "<string>",
"Information": "<string>"
}
}
}
],
"CreatedOn": "2023-11-07T05:31:56Z",
"LastModifiedOn": "2023-11-07T05:31:56Z"
}
]Location Management: Get List
View existing location lists with complete details for all points including coordinates, addresses, and metadata.
POST
/
LocationServices
/
LocationManagement
/
GetLists
/
v1.10
/
json6.ws
LocationServices_LocationManagement_GetLists
curl --request POST \
--url 'https://api.addressy.com/LocationServices/LocationManagement/GetLists/v1.10/json6.ws?Key=' \
--header 'Content-Type: application/json' \
--data '
{
"Key": "AA11-AA11-AA11-AA11",
"listId": "<string>"
}
'import requests
url = "https://api.addressy.com/LocationServices/LocationManagement/GetLists/v1.10/json6.ws?Key="
payload = {
"Key": "AA11-AA11-AA11-AA11",
"listId": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({Key: 'AA11-AA11-AA11-AA11', listId: '<string>'})
};
fetch('https://api.addressy.com/LocationServices/LocationManagement/GetLists/v1.10/json6.ws?Key=', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.addressy.com/LocationServices/LocationManagement/GetLists/v1.10/json6.ws?Key=",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'Key' => 'AA11-AA11-AA11-AA11',
'listId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.addressy.com/LocationServices/LocationManagement/GetLists/v1.10/json6.ws?Key="
payload := strings.NewReader("{\n \"Key\": \"AA11-AA11-AA11-AA11\",\n \"listId\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.addressy.com/LocationServices/LocationManagement/GetLists/v1.10/json6.ws?Key=")
.header("Content-Type", "application/json")
.body("{\n \"Key\": \"AA11-AA11-AA11-AA11\",\n \"listId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.addressy.com/LocationServices/LocationManagement/GetLists/v1.10/json6.ws?Key=")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"Key\": \"AA11-AA11-AA11-AA11\",\n \"listId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body[
{
"ListId": "<string>",
"ListName": "<string>",
"LatestRelatedListId": "<string>",
"IsErrorList": true,
"ListDescription": "<string>",
"Locations": [
{
"Id": "<string>",
"Name": "<string>",
"Description": "<string>",
"Address": "<string>",
"Country": "<string>",
"Latitude": "<string>",
"Longitude": "<string>",
"MetaInfo": {},
"UnstructuredMetaInfo": {},
"OpeningHours": {
"Monday": {
"Open": "<string>",
"Close": "<string>",
"Information": "<string>"
},
"Tuesday": {
"Open": "<string>",
"Close": "<string>",
"Information": "<string>"
},
"Wednesday": {
"Open": "<string>",
"Close": "<string>",
"Information": "<string>"
},
"Thursday": {
"Open": "<string>",
"Close": "<string>",
"Information": "<string>"
},
"Friday": {
"Open": "<string>",
"Close": "<string>",
"Information": "<string>"
},
"Saturday": {
"Open": "<string>",
"Close": "<string>",
"Information": "<string>"
},
"Sunday": {
"Open": "<string>",
"Close": "<string>",
"Information": "<string>"
}
}
}
],
"CreatedOn": "2023-11-07T05:31:56Z",
"LastModifiedOn": "2023-11-07T05:31:56Z"
}
]The Get List API allows you to view an existing list created using our Create List endpoint.
Authorizations
Body
application/json
The key you want to use to authenticate with the service (you can request we create one for you or create one in your account section).
The unique GUID for a given list.
Response
Success
An automatically generated GuID used to uniquely identify a list.
The name of the list passed in the request.
The description of the list passed in the request.
An array of objects that is populated with information about a location. Also contains a uniquely generated GuID per point.
Show child attributes
Show child attributes
The date and time of when the list was initially created.
The date and time of when the list was last modified.
Was this page helpful?
⌘I

