Icons

Icon

Returns the whole built-in icon catalogue used to decorate categories and fields, in the order the icon packs ship them, unpaged and uncapped. The catalogue is the same for every workspace and cannot be added to through the API; each item is metadata (name, tags, categories and the relative path of its SVG file), not the image itself.

GET /api/sys/v{version:apiVersion}/icons

Authorisation: Minimum role: USER

Request arguments

Name	Type	Source
filter	DTO_icon_filter	Query

Request body example

Response

Status: 200 (OK)
Type: DTO_icon[]

Wrapper: DTO_response_wrap

Other statuses: 403 (Forbidden)

Response body example

DTO_icon_filter

Name	Type	ReadOnly	Description
icon_ids	Int64[]		Icon ids

DTO_icon

Name	Type	Description
id	Int32	Id
name	String	Name
file	String	File
tags	String[]	Tags
categories	String[]	Categories

Generated Aug 4, 2026 18:37