List product catalog

What is the Product Catalog? The product catalog in Leadtime is used for the central management of all standardizable services and products of a company. It helps you manage all your standardisable services and products in one place, structure offers, set prices, and define variations or options. The catalog is the base for sales, quotes, and billing of recurring services.

What is a Product? A product is a standardized, reusable unit of service for your business. It can be a physical item, a software license, or a clearly defined service that is offered with fixed or recurring prices. Unlike projects that are tailored to customer needs, a product describes a predefined, repeatable offering that can be sold multiple times and used directly in proposals, invoices, or projects.

What data is returned: This endpoint returns a paginated, filterable, and sortable list of all catalog products in your workspace. Each product includes:

Basic information: name, category, logo
Pricing: fixed price, subscription price, per-unit price
Structure: number of variants and options
Metadata: creation date, last update

Supported operations:

Filter by category, name, pricing type, or any other field
Sort by any column (name, price, category, etc.)
Search across product names
Paginate through large catalogs

Retrieves a paginated grid of product catalog with filtering and sorting capabilities. Quick search available on: name. Filterable fields: id, name, categoryId, logoId, optionsCount, variantsCount, priceFixed, priceSubscription, pricePerUnit. Sortable fields: id, name, categoryId, optionsCount, variantsCount, priceFixed, priceSubscription, pricePerUnit.

GET/administration/product-catalog

Authorization

AuthorizationOAuth2 access token · headerrequired

Scopes:api:read

AuthorizationBearer token (JWT) · headerrequired

Query parameters

pagenumber

Page number (1-based)

pageSizenumber

Number of items per page

viewIdstring

View identifier for saved grid configurations

quickSearchstring

Quick search text. Searches across: name

filtersstring

JSON string containing filter configuration.

Available Fields:

id (string): Product ID
name (string): Product name
categoryId (string): Category ID
logoId (string): Logo file ID
optionsCount (number): Number of product options
variantsCount (number): Number of product variants
priceFixed (number): Fixed price
priceSubscription (number): Subscription price
pricePerUnit (number): Price per unit

Filter Structure:

[
  {
    "type": "string|number|date|set|boolean|array|task_status|task_type",
    "fieldName": "field_name",
    "value": {
      "comparison": "comparison_type",
      "value": "filter_value"
    }
  }
]

Group Filters (AND/OR Combinations):

[
  {
    "type": "group",
    "fieldName": "group0.18807479823070028",
    "value": {
      "type": "or",
      "filters": [
        {
          "type": "string",
          "fieldName": "fileName",
          "value": {
            "comparison": "contain",
            "value": "aa"
          }
        },
        {
          "type": "number",
          "fieldName": "rowCount",
          "value": {
            "comparison": ">=",
            "value": 33
          }
        }
      ]
    }
  }
]

Available Comparison Operators:

id (string): Product ID (string filter). Available comparisons: contain, not_contain, equal, starts_with, ends_with, is_empty, is_not_empty
name (string): Product name (string filter). Available comparisons: contain, not_contain, equal, starts_with, ends_with, is_empty, is_not_empty
categoryId (string): Category ID (string filter). Available comparisons: contain, not_contain, equal, starts_with, ends_with, is_empty, is_not_empty
logoId (string): Logo file ID (string filter). Available comparisons: contain, not_contain, equal, starts_with, ends_with, is_empty, is_not_empty
optionsCount (number): Number of product options (number filter). Available comparisons: equal, not_equal, >, <, >=, <=, is_empty, is_not_empty
variantsCount (number): Number of product variants (number filter). Available comparisons: equal, not_equal, >, <, >=, <=, is_empty, is_not_empty
priceFixed (number): Fixed price (number filter). Available comparisons: equal, not_equal, >, <, >=, <=, is_empty, is_not_empty
priceSubscription (number): Subscription price (number filter). Available comparisons: equal, not_equal, >, <, >=, <=, is_empty, is_not_empty
pricePerUnit (number): Price per unit (number filter). Available comparisons: equal, not_equal, >, <, >=, <=, is_empty, is_not_empty

Note: Use quickSearch parameter for simple text search instead of adding it to filters.

sortstring

JSON array of sort objects.

Sortable Fields:

id: Product ID
name: Product name
categoryId: Category ID
optionsCount: Number of product options
variantsCount: Number of product variants
priceFixed: Fixed price
priceSubscription: Subscription price
pricePerUnit: Price per unit

Sort Structure:

[
  {
    "field": "field_name",
    "direction": "asc|desc"
  }
]

Default Sort: name (asc)

fieldsToReturnstring[]

Comma-separated list of field names to include in response items. If not provided, all fields are returned.

Available Fields: id, name, categoryId, logoId, optionsCount, variantsCount, priceFixed, priceSubscription, pricePerUnit

Responses

200

Paginated list of product catalog items

401

Unauthorized - Invalid or missing authentication token

403

Forbidden - Insufficient API scopes or permissions

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

OAuth2 access tokenRemember on this deviceInclude my values in samples

Parameters

pagequeryPage number (1-based)pageSizequeryNumber of items per pageviewIdqueryView identifier for saved grid configurationsquickSearchqueryQuick search text. Searches across: namefiltersqueryJSON string containing filter configuration. **Available Fields:** - **id** (string): Product ID - **name** (string): Product name - **categoryId** (string): Category ID - **logoId** (string): Logo file ID - **optionsCount** (number): Number of product options - **variantsCount** (number): Number of product variants - **priceFixed** (number): Fixed price - **priceSubscription** (number): Subscription price - **pricePerUnit** (number): Price per unit **Filter Structure:** ```json [ { "type": "string|number|date|set|boolean|array|task_status|task_type", "fieldName": "field_name", "value": { "comparison": "comparison_type", "value": "filter_value" } } ] ``` **Group Filters (AND/OR Combinations):** ```json [ { "type": "group", "fieldName": "group0.18807479823070028", "value": { "type": "or", "filters": [ { "type": "string", "fieldName": "fileName", "value": { "comparison": "contain", "value": "aa" } }, { "type": "number", "fieldName": "rowCount", "value": { "comparison": ">=", "value": 33 } } ] } } ] ``` **Available Comparison Operators:** - **id** (string): Product ID (string filter). Available comparisons: contain, not_contain, equal, starts_with, ends_with, is_empty, is_not_empty - **name** (string): Product name (string filter). Available comparisons: contain, not_contain, equal, starts_with, ends_with, is_empty, is_not_empty - **categoryId** (string): Category ID (string filter). Available comparisons: contain, not_contain, equal, starts_with, ends_with, is_empty, is_not_empty - **logoId** (string): Logo file ID (string filter). Available comparisons: contain, not_contain, equal, starts_with, ends_with, is_empty, is_not_empty - **optionsCount** (number): Number of product options (number filter). Available comparisons: equal, not_equal, >, <, >=, <=, is_empty, is_not_empty - **variantsCount** (number): Number of product variants (number filter). Available comparisons: equal, not_equal, >, <, >=, <=, is_empty, is_not_empty - **priceFixed** (number): Fixed price (number filter). Available comparisons: equal, not_equal, >, <, >=, <=, is_empty, is_not_empty - **priceSubscription** (number): Subscription price (number filter). Available comparisons: equal, not_equal, >, <, >=, <=, is_empty, is_not_empty - **pricePerUnit** (number): Price per unit (number filter). Available comparisons: equal, not_equal, >, <, >=, <=, is_empty, is_not_empty **Note:** Use `quickSearch` parameter for simple text search instead of adding it to filters.sortqueryJSON array of sort objects. **Sortable Fields:** - **id**: Product ID - **name**: Product name - **categoryId**: Category ID - **optionsCount**: Number of product options - **variantsCount**: Number of product variants - **priceFixed**: Fixed price - **priceSubscription**: Subscription price - **pricePerUnit**: Price per unit **Sort Structure:** ```json [ { "field": "field_name", "direction": "asc|desc" } ] ``` **Default Sort:** name (asc)fieldsToReturnqueryComma-separated list of field names to include in response items. If not provided, all fields are returned. **Available Fields:** id, name, categoryId, logoId, optionsCount, variantsCount, priceFixed, priceSubscription, pricePerUnit

Request

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

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

import requests

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

Response

Paginated list of product catalog items