---
title: "GET /layouts"
method: GET
path: "/layouts"
tags: ["Layouts"]
---

# GET /layouts

`GET /layouts`

This endpoint allows you to retrieve all the layouts associated with the account.
It is important to note that after using the pageSize parameter, the "totalSize"  in the response represents the total number of available layouts, not the number of layouts resulting from the query string.

## Query parameters

- `include` string[]
- `sort` string[]
- `pageToken` string
- `pageSize` integer
- `name` string — Name of the item.
- `name__in` string[]
- `name__contains` string
- `id__in` string
- `layoutPanes.cameras.bridgeId` string
- `q` string
- `qRelevance__gte` number, float

## Response `200`

Successfully fetched

- ApiPaginatedLayoutResponse — 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` ApiLayoutCreate[], required — The result set from a collection API call.
    - `panes` ApiPane[]
      - `id` integer, required — Unique identifier of pane in layout assigned to each pane. This determines the location indexing of panes in layout.
      - `name` string, required — Name of the pane in layout
      - `type` 'preview' | 'compositePreview', required — Possible values: * `preview` - show the view for a single camera using "preview" images which are lower resolution and lower frequency than the real stream. * `compositePreview` - show the composite of a de-warped camera view.
      - `size` integer, required — Size of displayed image in pane. Size 1 shows the smallest size
      - `cameraId` string, required — Unique identifier of the camera.
      - `compositeId` string, nullable — Unique identifier of the composite of a de-warped camera view.
    - `settings` object, required — Object identifying the layout settings
      - `showCameraBorder` boolean, required — This flag if enabled, shows pane borders.
      - `showCameraName` boolean, required — This flag if enabled, shows camera name
      - `cameraAspectRatio` '16x9' | '4x3', required — Aspect ratio of image
      - `paneColumns` integer, required — Max number of cameras to show per row
    - `name` string, required — Name of the layout.
  - `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.
- `500` — Something went wrong in the server. Please try again.

---

[API](https://skmtc.net/eagleeyenetworks/apis/devices.md) · [All operations](https://skmtc.net/eagleeyenetworks/apis/devices/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/eagleeyenetworks/devices/revisions/df57313de545/schema)