---
title: "Get All Products"
method: GET
path: "/products"
tags: ["Product"]
---

# Get All Products

`GET /products`

## Request

- Base URL: `https://api.renesas.com/web-data/v1`
- URL: `https://api.renesas.com/web-data/v1/products`
- Auth: API key in header `x-api-key`
- TypeScript: <https://skmtc.dev/renesas/apis/renesas-web-data-api/docs/products/get.ts> (a function with typed inputs; its response is checked against the schema)

## Query parameters

- `limit` integer
- `offset` integer
- `order` 'wwwUpdateDate' | 'title'
- `orderDirection` string
- `productId` string
- `category` string

## Response `200`

Successful response

- object
  - `data` Product[]
    - `productId` string: Unique identifier for the product.
    - `wwwUpdateDate` string: Date the product page was last updated on the website.
    - `uuid` string: UUID of the product.
    - `title` string: Title of the product page.
    - `url` string, uri: Public URL of the product page on the Renesas website.
    - `category` object[]: Category.
      - `level` 1 | 2 | 3 | 4: Level of the category: * 1 - Primary category * 2 - Secondary subcategory * 3 - Tertiary subcategory * 4 - Fourth-level subcategory
      - `title` string: Title of the category.
    - `description` string: Detailed description of the product.
    - `features` string: Key features and capabilities of the product.
    - `applications` string: Target applications and use cases.
    - `images` string[]: Array of image URLs for the product.
    - `orderableProducts` object[]: List of orderable product parts associated with this product.
      - `orderableId` string: Orderable product part identifier.
      - `href` string, uri: URL to the product part endpoint.
    - `relatedBoardsKits` object[]: List of related boards and kits.
      - `boardKitId` string: Related board or kit identifier.
      - `title` string: Title of the related board or kit.
      - `href` string, uri: URL to the board/kit endpoint.
    - `featuredDocuments` object[]: Featured documents associated with the product.
      - `agileId` string: Agile ID of the document.
      - `dcpDocumentId` string, nullable: DCP Document ID, if applicable.
      - `title` string: Document title.
      - `type` string: Document type.
      - `language` string: Document language.
      - `href` string, uri: Public URL of the document file.
    - `relatedDocuments` object[]: List of related document identifiers.
      - `agileId` string: Agile ID of the document.
      - `dcpDocumentId` string, nullable: DCP Document ID, if applicable.
      - `title` string: Document title.
      - `type` string: Document type.
      - `language` string: Document language.
      - `href` string, uri: Public URL of the document file.
    - `relatedDocumentsSecondary` object[]: List of secondary related document identifiers.
      - `agileId` string: Agile ID of the document.
      - `dcpDocumentId` string, nullable: DCP Document ID, if applicable.
      - `title` string: Document title.
      - `type` string: Document type.
      - `language` string: Document language.
      - `href` string, uri: Public URL of the document file.
    - `softwareTools` object[]: List of software tools and sample code associated with this product.
      - `softwareToolName` string: Software tool identifier (uses full title).
      - `href` string, uri: URL to the software tool endpoint.
    - `applicationBlockDiagrams` object[]: List of application block diagrams associated with this product.
      - `title` string: Title of the application block diagram.
      - `description` string: Brief description of the application.
      - `imageUrl` string, uri: Thumbnail image URL of the block diagram.
      - `url` string, uri: URL to the full application block diagram page.
  - `pagination` object
    - `offset` integer: The actual offset used (page * limit)
    - `limit` integer: The number of items per page
    - `total` integer: Total number of items available
    - `has_more` boolean: Whether there are more items available

## Other responses

- `500`: Internal server error

---

[API](https://skmtc.dev/renesas/apis/renesas-web-data-api.md) - [All operations](https://skmtc.dev/renesas/apis/renesas-web-data-api/llms.txt) - [OpenAPI document](https://skmtc.dev/renesas/apis/renesas-web-data-api/revisions/4a72e6c49b2c?raw)