# LayoutFilter

**Kind**: interface | **Module**: [Layouts](https://docs.interop.io/desktop/reference/javascript/layouts/index.md)

**Source**: https://docs.interop.io/desktop/reference/javascript/layouts/layoutfilter/index.html

Filter for retrieving Layouts. If no filter properties are specified, all Layouts will be retrieved.

## Properties

- **`includeAccessInfo`** (`boolean`, optional) default: `false`
  If `true`, the returned Layouts will contain information about their owner and the users and groups with access to them.
- **`includeComponents`** (`boolean`, optional) default: `false`
  If `true`, the returned Layouts will contain their app components.
- **`includeContext`** (`boolean`, optional) default: `false`
  If `true`, the returned Layouts will contain their context.
- **`name`** (`string`, optional)
  Name of the Layouts to retrieve (exact match).
- **`type`** (`LayoutType`, optional)
  Type of the Layouts to retrieve.

## Related types

- [LayoutType](https://docs.interop.io/desktop/reference/javascript/layouts/layouttype/index.md)
