Skip to main content
POST
/
LocationServices
/
LocationManagement
/
GetLists
/
v1.10
/
json6.ws
cURL
curl --request POST \
  --url https://api.addressy.com/LocationServices/LocationManagement/GetLists/v1.10/json6.ws \
  --header 'Content-Type: application/json' \
  --data '{
  "Key": "<string>",
  "listId": "<string>"
}'
[
{
"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.

Body

application/json
Key
string
default:AA11-AA11-AA11-AA11
required

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).

listId
string | null

The unique GUID for a given list.

Response

Success

ListId
string | null

An automatically generated GuID used to uniquely identify a list.

ListName
string | null

The name of the list passed in the request.

IsErrorList
boolean
ListDescription
string | null

The description of the list passed in the request.

Locations
object[] | null

An array of objects that is populated with information about a location. Also contains a uniquely generated GuID per point.

CreatedOn
string<date-time> | null

The date and time of when the list was initially created.

LastModifiedOn
string<date-time> | null

The date and time of when the list was last modified.

I