---
title: "LocationServices_LocationManagement_GetLists"
method: POST
path: "/LocationServices/LocationManagement/GetLists/v1.10/json6.ws"
tags: ["LocationServices_LocationManagement_GetLists"]
---

# LocationServices_LocationManagement_GetLists

`POST /LocationServices/LocationManagement/GetLists/v1.10/json6.ws`

## Request

- Base URL: `https://api.addressy.com`
- URL: `https://api.addressy.com/LocationServices/LocationManagement/GetLists/v1.10/json6.ws`
- Auth: API key in query parameter `Key`

## Request body

- object
  - `Key` string, 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](https://account.loqate.com/account#/)).
  - `listId` string: The unique GUID for a given list.

## Response `200`

Success

- ExternalEndpointResponseItem[]
  - `ListId` string: An automatically generated GuID used to uniquely identify a list.
  - `ListName` string: The name of the list passed in the request.
  - `LatestRelatedListId` string
  - `IsErrorList` boolean
  - `ListDescription` string: The description of the list passed in the request.
  - `Locations` ExternalResponsePointData[]: An array of objects that is populated with information about a location. Also contains a uniquely generated GuID per point.
    - `Id` string
    - `Name` string
    - `Description` string
    - `Address` string
    - `Country` string
    - `Latitude` string
    - `Longitude` string
    - `MetaInfo` object
    - `UnstructuredMetaInfo` object
    - `OpeningHours` ExternalResponseOpeningHours
      - `Monday` ExternalResponseDay
        - `Open` string
        - `Close` string
        - `Information` string
      - `Tuesday` ExternalResponseDay
        - `Open` string
        - `Close` string
        - `Information` string
      - `Wednesday` ExternalResponseDay
        - `Open` string
        - `Close` string
        - `Information` string
      - `Thursday` ExternalResponseDay
        - `Open` string
        - `Close` string
        - `Information` string
      - `Friday` ExternalResponseDay
        - `Open` string
        - `Close` string
        - `Information` string
      - `Saturday` ExternalResponseDay
        - `Open` string
        - `Close` string
        - `Information` string
      - `Sunday` ExternalResponseDay
        - `Open` string
        - `Close` string
        - `Information` string
  - `CreatedOn` string, date-time, nullable: The date and time of when the list was initially created.
  - `LastModifiedOn` string, date-time, nullable: The date and time of when the list was last modified.

## Other responses

- `400`: BadRequest
- `401`: Unauthorized
- `403`: Forbidden
- `404`: NotFound
- `500`: InternalServerError

---

[API](https://skmtc.dev/loqate/apis/locationservices-locationmanagement-getlists.md) - [All operations](https://skmtc.dev/loqate/apis/locationservices-locationmanagement-getlists/llms.txt) - [OpenAPI document](https://skmtc.dev/loqate/apis/locationservices-locationmanagement-getlists/revisions/a212e1ac8357?raw)