List custom icons

Retrieves all custom icons configured for the workspace.

What are Custom Icons? Custom icons are user-uploaded symbols (images) that can be used throughout the workspace to visually organize and tag content. They help make information easier to grasp quickly.

Where can custom icons be used:

Projects
Tickets/Tasks
Documents
Organization profiles
Employee profiles

What is returned:

Icon ID and name (e.g., :company_logo: or :team_sales:)
Image file ID and public URL
Author information (who created the icon)
Creation and last update timestamps

Note: This endpoint requires the CustomIcons.create permission. All custom icons are available to all users in the workspace.

GET/administration/custom-icons

Authorization

AuthorizationOAuth2 access token · headerrequired

Scopes:api:read

AuthorizationBearer token (JWT) · headerrequired

Responses

200Custom icons retrieved successfully

Array of CustomIconResponseDto

authorIdstringrequired

ID (UUID) of the user who created this custom icon

createdAtstring<date-time>required

ISO 8601 date and time when the custom icon was created

idstringrequired

Unique identifier (UUID) of the custom icon

imageIdstringrequired

File ID (UUID) of the icon image file

imageUrlstringrequired

Full public URL to access and display the icon image. Use this URL to display the icon in your application.

namestringrequired

Name of the custom icon (e.g., `:company_logo:`, `:team_sales:`). This is the identifier used to reference the icon throughout the workspace.

updatedAtstring<date-time>required

ISO 8601 date and time when the custom icon was last updated (image replacement)

401Unauthorized - Invalid or missing authentication token

403Forbidden - Insufficient API scopes or permissions

Request

curl -X GET "https://leadtime.app/api/public/administration/custom-icons" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

const response = await fetch("https://leadtime.app/api/public/administration/custom-icons", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN"
  }
});

import requests

response = requests.get(
    "https://leadtime.app/api/public/administration/custom-icons",
    headers={
        "Authorization": "Bearer YOUR_ACCESS_TOKEN"
    },
)

Response

[
  {
    "authorId": "123e4567-e89b-12d3-a456-426614174000",
    "createdAt": "2024-01-15T10:30:00Z",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "imageId": "123e4567-e89b-12d3-a456-426614174000",
    "imageUrl": "https://app.workc.com/api/files/public/123e4567-e89b-12d3-a456-426614174000",
    "name": "company_logo",
    "updatedAt": "2024-01-15T10:30:00Z"
  }
]