Get product category details

Retrieves detailed information about a specific product category by its ID.

What is returned:

Category ID, name, icon, and description
Sort order for display
Multilingual translations (name and description in different languages)
Default key (for system-defined categories)
Creation and deletion timestamps

Note: This endpoint requires the manageSettings permission. Returns 404 if the category does not exist or has been deleted.

GET/administration/product-categories/{id}

Authorization

AuthorizationOAuth2 access token · headerrequired

Scopes:api:read

AuthorizationBearer token (JWT) · headerrequired

Path parameters

idstringrequired

Responses

200Product category retrieved successfully

createdAtstring<date-time>required

ISO 8601 timestamp indicating when the product category was created. Format: YYYY-MM-DDTHH:mm:ss.sssZ

defaultKeyobject

Default key identifier for system-defined categories (e.g., "software", "hardware", "consulting", "external_costs"). Only present for categories that were created from system defaults. Custom categories created by users do not have a defaultKey. This key is used when restoring default categories.

deletedAtobject

ISO 8601 timestamp indicating when the product category was soft-deleted, or null if not deleted. Format: YYYY-MM-DDTHH:mm:ss.sssZ. Soft-deleted categories are marked as deleted but not permanently removed.

descriptionobject

Optional description explaining what products or services belong to this category. Helps users understand the category purpose when creating or assigning products.

iconstringrequired

Icon identifier for the product category in emoji-style format :icon_name:. Icons help visually distinguish categories in lists and dropdowns.

idstringrequired

Unique identifier (UUID) of the product category. Use this ID to reference the category in other API calls.

namestringrequired

Display name of the product category. This is the primary name used to identify and organize products.

sortnumber

Numeric sort order for displaying categories. Lower numbers appear first. Used to control the order in which categories appear in dropdowns and lists.

translationsProductCategoryTranslationDto[]required

Array of translations for multilingual support. Each translation provides the category name and description in a specific language. Translations are automatically used in multilingual user interfaces and documents based on the user language preference.

Show properties

Array of ProductCategoryTranslationDto

descriptionobject

Translated description of the product category in the specified language. This description appears in multilingual user interfaces and documents when the user language matches.

languagestringrequired

ISO 639-1 language code for the translation (e.g., "en" for English, "de" for German). This determines which language interface will display this translation.

nameobject

Translated name of the product category in the specified language. This name appears in multilingual user interfaces and documents when the user language matches.

401Unauthorized - Invalid or missing authentication token

403Forbidden - Insufficient API scopes or permissions

Request

curl -X GET "https://leadtime.app/api/public/administration/product-categories/string" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

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

import requests

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

Response

{
  "createdAt": "2024-01-01T00:00:00.000Z",
  "defaultKey": "software",
  "deletedAt": null,
  "description": "Software products and licenses",
  "icon": ":package:",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "Software",
  "sort": 1,
  "translations": [
    {
      "description": "Software products and licenses",
      "language": "en",
      "name": "Software"
    },
    {
      "description": "Softwareprodukte und Lizenzen",
      "language": "de",
      "name": "Software"
    }
  ]
}