Public products API overview

The public products API returns the products in your catalogue that you have marked as public. Use it to show your catalogue in a webshop, a configurator, or any other system outside Installer.com. The endpoint needs no API key.

Before you begin

Only products with Public enabled are returned. Select Products in the sidebar, open a product, and turn on Public.

Request

Send a GET request to /api/v1/public/products/{slugOrId}, where slugOrId is your organization’s slug or its id.

The response leaves out internal pricing. Your internal price and the installer payout fields are removed before the products are returned.

Query parameters

Parameter	Type	Default	Notes
`page`	integer	`0`	Page number. The first page is `0`.
`pageSize`	integer	`25`	Products per page. The maximum is `500`.
`phrase`	string	—	Matches against the product name and description.
`productTypes`	string or array	—	One or more of `product`, `material`, `service`, `working_hours`, `reservation`.
`productTags`	string or array	—	Tag names. A product must carry every tag you list.
`orProductTags`	string or array	—	Tag names. A product must carry at least one of the tags you list.
`excludeProductIds`	string or array	—	Product ids to leave out of the results.

Send a parameter once for a single value, or repeat it for several. productTags and orProductTags can be combined; both conditions then apply.

Response

The response has two fields:

values — the products on the page you asked for, sorted by name.
count — the total number of products that match the request, not the number on the page.

Each product carries id, name, description, productType, unit, currencyCode, vatRate, payerUnitAmount and discountUnitAmount, along with its tags, images and attachments. Amounts are whole numbers in the currency’s minor unit, so 19900 is 199.00. vatRate is in hundredths of a percent, so 2500 is 25%. Each image and attachment includes a signed fileUrl.

Read the whole catalogue with an API key

The public endpoint returns public products only. To read every product in your catalogue, including your internal price, send a GET request to /api/v1/products with your API key as a bearer token. The same query parameters apply. /api/v1/products/{id} returns one product.

Need help? Contact Installer.com support.