# List entity layouts

> `GET` `/v1/entity-layouts`

URL: https://www.agencytitan.com/docs/tag/entity-layouts/GET/v1/entity-layouts

Operation ID: `entity_layouts_list`

Tag: [entity_layouts](https://www.agencytitan.com/docs/tag/entity-layouts.md)

## Description

Lists accessible layouts for one surface. Use process_definition_id for task-stage discovery, scope filters for embedded views or modals, or entity_id for an exact surface-scoped match. Rows omit the heavy `containers`, `draft_config`, and `published_config` structures by default; request them explicitly via the `fields` parameter (`?fields=containers,draft_config,published_config`, or `?fields=*`), or use Get an entity layout for the complete structure.

## Parameters

- `entity_id` (query, optional, `string`) — Optional exact owning entity id. Optional filter. Omit unless the user asked for it; never guess identifiers.
- `entity_type` (query, required, `string`) — Layout surface: task stage, client profile, modal, embedded view, main form, or form confirmation. Optional filter. Omit unless the user asked for it; never gu…
- `fields` (query, optional, `array<string>`) — Heavy row properties to include: `containers`, `draft_config`, and/or `published_config` (omitted from rows by default). Comma-separate and/or repeat the param…
- `folder_id` (query, optional, `string`) — Optional view or modal folder id. Optional filter. Omit unless the user asked for it; never guess identifiers.
- `limit` (query, optional, `integer`) — Maximum number of items to return (1-200).
- `offset` (query, optional, `integer`) — Number of items to skip before collecting the result set.
- `order` (query, optional, `string`) — Sort direction. Default `asc`.
- `process_definition_id` (query, optional, `string`) — Required to enumerate task-stage layouts when entity_id is omitted. Optional filter. Omit unless the user asked for it; never guess identifiers.
- `scope_id` (query, optional, `string`) — Optional view or modal scope entity id. Optional filter. Omit unless the user asked for it; never guess identifiers.
- `scope_type` (query, optional, `string`) — Optional view or modal scope type. Optional filter. Omit unless the user asked for it; never guess identifiers.
- `search` (query, optional, `string`) — Free-text search filter.
- `sort` (query, optional, `string`) — Field to sort by. Default `entity_name`.

## Request body

_None_

## Responses

- `200` (`application/json`): Successful response.
  - Type: `object`
  - Properties:
    - `data` (`array<object>`, required)
    - `pagination` (`object`, required)
- `400` (`application/json`): Request validation failed (unknown or out-of-range parameters/properties are rejected).
  - Type: `object`
  - Properties:
    - `error` (`object`, required)
- `401` (`application/json`): Missing, invalid, expired, or revoked bearer token.
  - Type: `object`
  - Properties:
    - `error` (`string`, required)
    - `error_description` (`string`, required)
- `403` (`application/json`): The authenticated user does not have permission for this operation.
  - Type: `object`
  - Properties:
    - `error` (`object`, required)
- `404` (`application/json`): The requested resource was not found.
  - Type: `object`
  - Properties:
    - `error` (`object`, required)
- `429` (`application/json`): Per-tenant rate limit exceeded (600 requests/minute across all /v1 REST endpoints). The Retry-After header indicates how many seconds to wait.
  - Type: `object`
  - Properties:
    - `error` (`object`, required)
- `500` (`application/json`): An unexpected internal error occurred.
  - Type: `object`
  - Properties:
    - `error` (`object`, required)

## Authentication

- `bearerAuth` — http (bearer) — All /v1 endpoints (except `/v1/openapi.json` and `/v1/llms.txt`) require a bearer token. Two equal first-class paths: (1) an OAuth 2.0 access token from the au…

## Useful links

- Interactive page: https://www.agencytitan.com/docs/tag/entity-layouts/GET/v1/entity-layouts
- API reference home: https://www.agencytitan.com/docs/
- Tag page: https://www.agencytitan.com/docs/tag/entity-layouts.md
- This operation as Markdown: https://www.agencytitan.com/docs/tag/entity-layouts/GET/v1/entity-layouts.md
- OpenAPI JSON: https://www.agencytitan.com/docs/openapi.json
- Full API Markdown: https://api.agencytitan.com/v1/llms.txt
- API keys: https://app.agencytitan.com/settings/api-mcp