---
title: "Add a tab view (legacy)"
method: POST
path: "/api/board/{boardId}/tabView"
tags: ["Board"]
---

# Add a tab view (legacy)

`POST /api/board/{boardId}/tabView`

## Request

- Base URL: `https://core-api.getaptly.com`
- URL: `https://core-api.getaptly.com/api/board/{boardId}/tabView`
- Auth: one of:
  - API key in header `x-token`
  - API key in header `Authorization`
- TypeScript: <https://skmtc.dev/getaptly/apis/aptly-api/docs/api/board/:boardId/tabView/post.ts> (a function with typed inputs; its response is checked against the schema)

Deprecated alias for `POST /api/board/{boardId}/configuration/tabViews`. Adds an
embedded tab view to the board's tab list. Use the `/configuration/tabViews` path
for new integrations.

## Path parameters

- `boardId` string, required

## Request body

- object
  - `name` string, required: Display name for the tab.
  - `url` string, required: URL to embed in the tab.
  - `icon` string: Font Awesome icon class (default `fa-regular fa-globe`).
  - `embedSource` string: Embed source identifier (default `aptly-ai`).
  - `filter` string: Filter preset (default `quickview_all-records`).
  - `userIds` string[]: User IDs that can see this tab. Empty = visible to all.
  - `createdBy` string: Aptly user ID of the creator.

## Response `200`

Tab view created.

- object
  - `data` TabView
    - `uuid` string
    - `name` string
    - `url` string
    - `icon` string
    - `embedSource` string
    - `type` string

## Other responses

- `400`: Missing required fields.
- `401`: Invalid or missing API key.
- `404`: Board not found.

---

[API](https://skmtc.dev/getaptly/apis/aptly-api.md) - [All operations](https://skmtc.dev/getaptly/apis/aptly-api/llms.txt) - [OpenAPI document](https://skmtc.dev/getaptly/apis/aptly-api/revisions/75c367e0b8e5?raw)