Board

Add a tab view (legacy)

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.

post/api/board/{boardId}/tabView

Request

Base URL
https://core-api.getaptly.com
Auth
- API key in header x-token
- or 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.

Path parameters

boardIdstring required

Request body

namestring required

Display name for the tab.

urlstring required

URL to embed in the tab.

iconstring

Font Awesome icon class (default fa-regular fa-globe).

embedSourcestring

Embed source identifier (default aptly-ai).

filterstring

Filter preset (default quickview_all-records).

userIdsstring[]

User IDs that can see this tab. Empty = visible to all.

createdBystring

Aptly user ID of the creator.

Response

Tab view created.

Changes

No recorded changes to this operation across all 1 revision of this API.