---
title: "GET /locations/{locationId}/floors/{id}/plans"
method: GET
path: "/locations/{locationId}/floors/{id}/plans"
tags: ["Floor Plans"]
---

# GET /locations/{locationId}/floors/{id}/plans

`GET /locations/{locationId}/floors/{id}/plans`

## Request

- Base URL: `https://api.cxxx.eagleeyenetworks.com/api/v3.0`
- URL: `https://api.cxxx.eagleeyenetworks.com/api/v3.0/locations/{locationId}/floors/{id}/plans`
- Auth: HTTP bearer

This endpoint allows you to retrieve plans of a specific floor at a specific location. Support for Location-based camera grouping is only available in the professional and enterprise editions.
To retrieve an image file of the floor plan, please use the [`/locations/{locationId}/floors/{id}.{type}`](ref:getfloorimage) endpoint. The `type` parameter in that endpoint corresponds to the `type` property in the response of this resource.

## Query parameters

- `pageToken` string
- `pageSize` integer

## Response `200`

Successfully fetched

- PaginatedFloorPlansResponse: Used to wrap results for a paginated response, containing information on how to retrieve further pages.
  - `nextPageToken` string, nullable, required: Token to retrieve the next page. The value of this token is passed into the field pageToken. This value can be null if there is no next page.
  - `prevPageToken` string, nullable, required: Token to retrieve the previous page. The value of this token is passed into the field pageToken. This value can be null of there is no previous page.
  - `results` FloorPlan[], required: The result set from a collection API call.
    - `id` string: Unique identifier of the floor plan
    - `floorId` string: Unique identifier of the floor
    - `type` 'png' | 'svg' | 'pdf': Type of the floor image
    - `creator` 'originalUpload' | 'cloudGenerated'
  - `totalSize` integer, required: Size of the total result set.

## Other responses

- `400`: The supplied object is invalid. Error detail will contain the validation error.
- `401`: You are not authenticated. Please authenticate and try again.
- `403`: You have no permission to access the specified resource.
- `500`: Something went wrong in the server. Please try again.

---

[API](https://skmtc.dev/eagleeyenetworks/apis/grouping.md) - [All operations](https://skmtc.dev/eagleeyenetworks/apis/grouping/llms.txt) - [OpenAPI document](https://skmtc.dev/eagleeyenetworks/apis/grouping/revisions/ae90740cce1c?raw)