---
title: "Get All Documents"
method: GET
path: "/documents"
tags: ["Document"]
---

# Get All Documents

`GET /documents`

## Request

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

## Query parameters

- `limit` integer
- `offset` integer
- `language` 'en' | 'ja' | 'zh-hans'
- `dcpDocumentIdStartsWith` string
- `productId` string
- `type` string
- `subType` string
- `category` string
- `documentRevisionDateStart` string, date
- `documentRevisionDateEnd` string, date

## Response `200`

Successful response

- object
  - `data` Document[]
    - `agileId` string: Primary Agile ID of the document.
    - `dcpDocumentId` string: DCP Document ID, if applicable.
    - `url` string, uri: URL to download the document.
    - `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.
    - `product` object[]: List of associated products.
      - `productId` string: Associated product ID.
      - `type` 'Product' | 'Board & Kit' | 'Software Tool': Type of the associated product.
      - `title` string: Associated product title.
      - `nid` string: Drupal node ID of the product.
      - `uuid` string: UUID of the product node.
      - `language` string: Language code of the product node.
    - `title` string: Title of the document.
    - `type` string: Type of the document (e.g., Flyer, App Note).
    - `subType` string[]: Sub-types of the document. Example values: `Core Module`, `Driver Package`, `FIT Module`, `FreeRTOS`, `Software Integration System Application Example`, `Development Environment`, `Middleware`, `Migration Guide`, `Peripherals - Analog`, `Peripherals - Built-in Memory`, `Peripherals - Clock`, `Peripherals - Communication`, `Peripherals - Other`, `Peripherals - Security`, `Peripherals - Timer`.
    - `fileType` string: File format (e.g., PDF, DOCX).
    - `secureDocument` boolean: Indicates if the document is secure or restricted.
    - `revisionDate` string: Original revision date of the document.
    - `wwwUpdateDate` string: Date the document was last updated on the website.
    - `language` string: Language of the document (e.g., en, ja, zh-hans).
    - `nid` string: Drupal node ID of the document.
    - `uuid` string: UUID of the document node.
    - `translation` object[]: List of translations for the document.
      - `language` string: Language of the document (e.g., en, ja, zh).
      - `dcpDocumentId` string: DCP Document ID of the translation.
      - `agileId` string: Agile ID of the translation.
      - `title` string: Title of the translation document.
      - `href` string, uri: URL to retrieve the translation document.
    - `published` boolean: Publication status of the document.
    - `featured` boolean: Whether the document is featured or highlighted.
    - `relationship` string: Relationship or association type, if any.
    - `filename` string: Original filename of the document.
    - `disclaimer` object[]: List of associated disclaimer documents.
      - `dcpDocumentId` string: DCP Document ID of the disclaimer document.
      - `agileId` string: Agile ID of the disclaimer document.
      - `language` string: Language of the document (e.g., en, ja, zh).
      - `title` string: Title of the disclaimer document.
      - `href` string, uri: URL to retrieve the disclaimer document.
    - `myrenesasDocument` boolean: Is a MyRenesas document.
  - `pagination` object
    - `offset` integer: The actual offset used
    - `limit` integer: The number of items per page
    - `total` integer: Total number of items available
    - `has_more` boolean: Whether there are more items available

---

[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)