# List a location's venues

Returns the venues filed under one location - the addressable places within it that
roles are advertised at.
The listing is only paginated when `page` is supplied. Without it every match is
returned as a flat array rather than in the paged envelope.

Endpoint: GET /api/v2/headcount/location/{location_id}/venue
Version: 2.0.0
Security: default

## Path parameters:

  - `location_id` (integer, required)
    The ID of the location.

## Query parameters:

  - `per_page` (integer)
    The number of results to return per page. The higher the number the longer the request may take.
It is highly recommended to use this to avoid timeouts as your data grows.
Used in conjunction with the `page` parameter to paginate results.

  - `page` (integer)
    The page of results to return. Used in conjunction with the `per_page` parameter to paginate
results. If not specified, defaults to 1.
The response's next_page_url will be null if there are no
more pages.

  - `filter` (array)
    A filter to apply to the results. Declared as an array of objects, where each object
contains an attr (attribute code), operator and value key. Examples:

?filter[0]['attr']=name&filter[0][operator]=like&filter[0][value]=luke 

?filter[0]['attr']=id&filter[0][operator]=>&filter[0][value]=265 

See the filters documentation for more details on how to use this.

  - `sort_by` (string)
    The field to sort the results by. No ordering is applied unless you specify one, so
row order is not guaranteed. Always send it when paging through a list, otherwise
records can repeat or be missed between pages.
Example: id

  - `sort_order` (string)
    The direction to sort the results by. Can be 'asc' or 'desc', default is 'asc'.

  - `_locale` (string)
    The locale to use for the response. This primarily affects the results of the `nice` field, which
contain human-readable labels and terms, as well as locale-specific date formats.,

  - `extras` (array)
    A list of extras to include in the response. These are objects or arrays that are not part of
the model's primary attributes, such as stats and counts.
For fast responses, avoid requesting them if you don't need them.

## Header parameters:

  - `Rosterfy-Platform` (string)

## Response 200 fields (application/json):

  - `current_page` (integer)

  - `data` (array)

  - `data.object` (object)

  - `data.object.id` (integer)

  - `data.object.headcount_location_id` (integer)

  - `data.object.name` (string)

  - `data.object.frontend_name` (string)

  - `data.object.code` (string)

  - `data.object.is_virtual` (integer)

  - `data.object.description` (string)

  - `data.object.is_system` (integer)

  - `data.object.training_ids` (array)

  - `data.object.deleted_at` (string | null)

  - `data.object.created_at` (string)

  - `data.object.updated_at` (string)

  - `data.object.uuid` (string)

  - `data.object.address` (object)

  - `data.object.address.iso` (string)

  - `data.object.address.region_code` (string)

  - `data.object.address.coordinates` (object)

  - `data.object.address.coordinates.latitude` (string | null)

  - `data.object.address.coordinates.longitude` (string | null)

  - `data.object.address.street_address_1` (string)

  - `data.object.address.street_address_2` (string | null)

  - `data.object.address.street_address_3` (string | null)

  - `data.object.address.city` (string)

  - `data.object.address.postcode` (string)

  - `data.object.address.region` (string)

  - `data.object.address.country` (string)

  - `data.object.address.latitude` (string | null)

  - `data.object.address.longitude` (string | null)

  - `data.nice` (object)

  - `data.nice.rrn` (string)

  - `data.nice.address` (string)

  - `data.nice.address_oneline` (string)

  - `data.nice.address.country` (string)

  - `data.nice.address.country:raw` (string)

  - `data.nice.address.city` (string)

  - `data.nice.address.region` (string)

  - `data.nice.address.region:raw` (string)

  - `data.nice.address.postcode` (string)

  - `data.nice.address.street_address_1` (string)

  - `data.nice.address.street_address_2` (string | null)

  - `data.nice.address.street_address_3` (string | null)

  - `data.nice.address.latitude` (string | null)

  - `data.nice.address.longitude` (string | null)

  - `data.nice.location_name` (string)

  - `data.nice.headcount_location_type_name` (string)

  - `data.nice.headcount_location_type_id` (integer)

  - `data.relations` (object)

  - `data.relations.location` (object)

  - `data.relations.location.object` (object)

  - `data.relations.location.object.id` (integer)

  - `data.relations.location.object.account_id` (integer)

  - `data.relations.location.object.headcount_location_type_id` (integer)

  - `data.relations.location.object.name` (string)

  - `data.relations.location.object.frontend_name` (string)

  - `data.relations.location.object.code` (string)

  - `data.relations.location.object.training_ids` (array)

  - `data.relations.location.object.is_system` (integer)

  - `data.relations.location.object.deleted_at` (string | null)

  - `data.relations.location.object.created_at` (string)

  - `data.relations.location.object.updated_at` (string)

  - `data.relations.location.object.uuid` (string)

  - `data.relations.location.nice` (object)

  - `data.relations.location.nice.rrn` (string)

  - `data.relations.location.nice.headcount_location_type_name` (string)

  - `data.relations.location.permissions` (object)

  - `data.relations.location.permissions.read` (boolean)

  - `data.relations.location.permissions.update` (boolean)

  - `data.relations.location.permissions.delete` (boolean)

  - `data.permissions` (object)

  - `data.permissions.read` (boolean)

  - `data.permissions.update` (boolean)

  - `data.permissions.delete` (boolean)

  - `first_page_url` (string)

  - `from` (integer)

  - `next_page_url` (string)

  - `path` (string)

  - `per_page` (integer)

  - `prev_page_url` (string | null)

  - `to` (integer)