# Get Place List

Get a place list by ID.
Single GET returns the full Place List by default, including nested
`places[]`.

Endpoint: GET /place_lists/{place_list_id}
Version: 3.0.1807
Security: Auth0

## Security:

  - `Auth0` (unknown)
    oauth2 scopes: offline_access, manage:services

## Path parameters:

  - `place_list_id` (integer, required)
    Numeric ID of the place list to get

## Query parameters:

  - `full` (string)
    To return all fields, set the value to `*`. For example, `full=*` will include all properties.

## Response 200:

  - `200` (unknown)
    Place list response

## Response 200 fields (application/json):

  - `data` (object)

  - `data.id` (integer)
    Example: 126

  - `data.entity_type` (string)
    Example: place_list

  - `data.version` (integer)
    Example: 2

  - `data.organization_id` (integer)
    Example: 100048

  - `data.name` (string)
    Example: Starbucks Stores - New York

  - `data.description` (string)
    Example: NYC flagship + competitor zones

  - `data.filename` (string)
    Example: starbucks_new_york.csv

  - `data.content_updated_on` (string)

  - `data.places_count` (integer)
    Example: 42

  - `data.strategy_count` (integer)
    Number of strategies currently assigned to this Place List through PLCS geofence targeting.

  - `data.created_on` (string)

  - `data.updated_on` (string)

  - `data.places` (array)
    Nested places — returned on create/update and single GET responses

  - `data.places.id` (integer)
    Example: 5001

  - `data.places.name` (string)
    Example: Times Square

  - `data.places.external_id` (string)
    Example: STORE-001

  - `data.places.geometry_type` (string)
    Returned by the API and must not be supplied by users
    Enum: "circle"

  - `data.places.latitude` (number)
    Example: 40.7589

  - `data.places.longitude` (number)
    Example: -73.9851

  - `data.places.radius_meters` (integer)
    Example: 1000

  - `meta` (object)

  - `meta.status` (string, required)
    Example: success

## Response 400:

  - `400` (unknown)
    Error response

## Response 400 fields (application/json):

  - `errors` (array, required)

  - `errors.code` (string)

  - `errors.sub_code` (string)
    Optional identifier that refines the generic `code` category (e.g. `html5-noscript-tag`). Present on HTML5 upload/preview validation errors; absent otherwise.

  - `errors.field` (string)
    Optional when it is a schema error

  - `errors.message` (string)

  - `meta` (object, required)

  - `meta.status` (string, required)

## Response 401:

  - `401` (unknown)
    Error response

## Response 401 fields (application/json):

  - `errors` (array, required)

  - `errors.code` (string)

  - `errors.sub_code` (string)
    Optional identifier that refines the generic `code` category (e.g. `html5-noscript-tag`). Present on HTML5 upload/preview validation errors; absent otherwise.

  - `errors.field` (string)
    Optional when it is a schema error

  - `errors.message` (string)

  - `meta` (object, required)

  - `meta.status` (string, required)

## Response 403:

  - `403` (unknown)
    Error response

## Response 403 fields (application/json):

  - `errors` (array, required)

  - `errors.code` (string)

  - `errors.sub_code` (string)
    Optional identifier that refines the generic `code` category (e.g. `html5-noscript-tag`). Present on HTML5 upload/preview validation errors; absent otherwise.

  - `errors.field` (string)
    Optional when it is a schema error

  - `errors.message` (string)

  - `meta` (object, required)

  - `meta.status` (string, required)

## Response 404:

  - `404` (unknown)
    Error response

## Response 404 fields (application/json):

  - `errors` (array, required)

  - `errors.code` (string)

  - `errors.sub_code` (string)
    Optional identifier that refines the generic `code` category (e.g. `html5-noscript-tag`). Present on HTML5 upload/preview validation errors; absent otherwise.

  - `errors.field` (string)
    Optional when it is a schema error

  - `errors.message` (string)

  - `meta` (object, required)

  - `meta.status` (string, required)