MEmediamath
Place Lists

Get Place List

Get a place list by ID.

Single GET returns the full Place List by default, including nested places[].

get/place_lists/{place_list_id}

Request

Path parameters

place_list_idinteger required

Numeric ID of the place list to get

Query parameters

fullstring
Example:*

To return all fields, set the value to *. For example, full=* will include all properties.

Response

Place list response

Example response

{
  "data": {
    "id": 126,
    "entity_type": "place_list",
    "version": 2,
    "organization_id": 100048,
    "name": "Starbucks Stores - New York",
    "description": "NYC flagship + competitor zones",
    "filename": "starbucks_new_york.csv",
    "places_count": 42,
    "places": [
      {
        "id": 5001,
        "name": "Times Square",
        "external_id": "STORE-001",
        "geometry_type": "circle",
        "latitude": 40.7589,
        "longitude": -73.9851,
        "radius_meters": 1000
      }
    ]
  },
  "meta": {
    "status": "success"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.