Get product details

Returns full product details including variants, options, and HTML-formatted description.

This endpoint provides complete information about a product in a project, including:

Product Information:

Basic details (name, description as HTML, category, logo)
Pricing structure (fixed price, subscription price, per-unit price)
Price calculation details (unit name, frequency, final calculated prices)
Quantity and active date ranges

Variants:

All available product variants (e.g., Standard, Pro, Enterprise)
Each variant includes its own pricing and HTML-formatted description
Active variant status and sort order

Options:

All available product options (add-ons or configuration choices)
Option values with extra pricing adjustments
Required/multiple selection settings

The description and variant descriptions are returned as HTML, converted from the internal document format.

GET/projects/{projectId}/products/{productId}

Authorization

AuthorizationOAuth2 access token · headerrequired

Scopes:api:read

AuthorizationBearer token (JWT) · headerrequired

Path parameters

projectIdstring<uuid>required

Project ID

productIdstring<uuid>required

Product ID

Responses

200

Product details retrieved successfully

activeFromstring<date> | nullrequired

Start date when this product becomes active. Format: ISO 8601 date (YYYY-MM-DD). Null if no start date is set.

activeTostring<date> | nullrequired

End date when this product becomes inactive. Format: ISO 8601 date (YYYY-MM-DD). Null if no end date is set.

categoryIdstringrequired

UUID of the product category

descriptionstringrequired

Product description formatted as HTML. Converted from the internal document format.

finalNameobject | nullrequired

Final display name combining product name and active variant name (if a variant is active)

finalPriceFixedobject | nullrequired

Final calculated fixed price including variant and option adjustments. This is the price used for billing.

finalPricePerUnitobject | nullrequired

Final calculated per-unit price including variant and option adjustments

finalPriceSubscriptionobject | nullrequired

Final calculated subscription price including variant and option adjustments. This is the recurring price per billing period.

idstringrequired

UUID of the product in the project

logoIdobject | nullrequired

UUID of the logo file associated with this product. Null if no logo is set.

namestringrequired

Product name as defined in the product

optionsProductOptionResponseDto[]required

Array of all available options for this product

Show properties

Array of ProductOptionResponseDto

idstringrequired

UUID of the option

isMultiplebooleanrequired

Whether multiple values can be selected from this option

isRequiredbooleanrequired

Whether this option must be selected when configuring the product

namestringrequired

Name of the option (e.g., Color, Size, Add-ons)

sortnumberrequired

Sort order of this option. Lower values appear first when listing options.

valuesProductOptionValueResponseDto[]required

Array of all possible values for this option

Show properties

Array of ProductOptionValueResponseDto

extraPriceFixedobject | nullrequired

Additional fixed price added when this option value is selected. Null or 0 if no extra fixed cost.

extraPricePerUnitobject | nullrequired

Additional per-unit price added when this option value is selected. Null or 0 if no extra per-unit cost.

extraPriceSubscriptionobject | nullrequired

Additional subscription price added per billing period when this option value is selected. Null or 0 if no extra subscription cost.

idstringrequired

UUID of the option value

isActivatedbooleanrequired

Whether this option value is currently selected/activated for the product

namestringrequired

Name of the option value (e.g., Red, Blue, Large, Small)

sortnumberrequired

Sort order of this option value. Lower values appear first when listing option values.

priceFixedobject | nullrequired

Base fixed price for the product before variant and option adjustments

priceFrequencyobject | nullrequired

Billing frequency in months for subscription and per-unit pricing. Valid values: 1, 3, 6, or 12.

pricePerUnitobject | nullrequired

Base per-unit price before variant and option adjustments

priceSubscriptionobject | nullrequired

Base subscription price per billing period before variant and option adjustments

priceUnitNameobject | nullrequired

Unit name for per-unit pricing (e.g., per user, per hour)

quantitynumberrequired

Number of units of this product in the project

variantsProductVariantResponseDto[]required

Array of all available variants for this product

Show properties

Array of ProductVariantResponseDto

descriptionobject | nullrequired

Variant description formatted as HTML. Describes what makes this variant different from others.

idstringrequired

UUID of the variant

isActivatedbooleanrequired

Whether this variant is currently active for the product. Only one variant can be active at a time.

namestringrequired

Name of the variant (e.g., Standard, Pro, Enterprise)

priceFixedobject | nullrequired

One-time fixed price for this variant. Null if this variant does not have fixed pricing.

pricePerUnitobject | nullrequired

Per-unit price for this variant. Null if this variant does not have per-unit pricing.

priceSubscriptionobject | nullrequired

Recurring subscription price per billing period for this variant. Null if this variant does not have subscription pricing.

sortnumberrequired

Sort order of this variant. Lower values appear first when listing variants.

401

Unauthorized - Invalid or missing authentication token

403

Forbidden - Insufficient permissions or no project access

404

Not Found - Product or project does not exist

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

OAuth2 access tokenRemember on this deviceInclude my values in samples

Parameters

projectIdpath*Project IDproductIdpath*Product ID

Request

curl -X GET "https://leadtime.app/api/public/projects/497f6eca-6276-4993-bfeb-53cbbbba6f08/products/497f6eca-6276-4993-bfeb-53cbbbba6f08" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

const response = await fetch("https://leadtime.app/api/public/projects/497f6eca-6276-4993-bfeb-53cbbbba6f08/products/497f6eca-6276-4993-bfeb-53cbbbba6f08", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN"
  }
});

import requests

response = requests.get(
    "https://leadtime.app/api/public/projects/497f6eca-6276-4993-bfeb-53cbbbba6f08/products/497f6eca-6276-4993-bfeb-53cbbbba6f08",
    headers={
        "Authorization": "Bearer YOUR_ACCESS_TOKEN"
    },
)

Response

{
  "activeFrom": "2024-01-01",
  "activeTo": "2024-12-31",
  "categoryId": "550e8400-e29b-41d4-a716-446655440001",
  "description": "<p>Product description</p>",
  "finalName": "Variant Name",
  "finalPriceFixed": 100,
  "finalPricePerUnit": 5,
  "finalPriceSubscription": 25,
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "logoId": "550e8400-e29b-41d4-a716-446655440008",
  "name": "Product Name",
  "options": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440004",
      "isMultiple": false,
      "isRequired": true,
      "name": "Color",
      "sort": 0,
      "values": [
        {
          "extraPriceFixed": 5,
          "extraPricePerUnit": 1,
          "extraPriceSubscription": 2,
          "id": "550e8400-e29b-41d4-a716-446655440007",
          "isActivated": true,
          "name": "Color: Red",
          "sort": 0
        }
      ]
    }
  ],
  "priceFixed": 100,
  "priceFrequency": 1,
  "pricePerUnit": 5,
  "priceSubscription": 25,
  "priceUnitName": "per user",
  "quantity": 1,
  "variants": [
    {
      "description": "<p>Premium variant with additional features</p>",
      "id": "550e8400-e29b-41d4-a716-446655440006",
      "isActivated": true,
      "name": "Premium",
      "priceFixed": 150,
      "pricePerUnit": 10,
      "priceSubscription": 50,
      "sort": 0
    }
  ]
}