# Get All Documents

Endpoint: GET /documents
Version: 1.2.0
Security: ApiKeyAuth

## Query parameters:

  - `limit` (integer)
    The number of results to return (default 10).

  - `offset` (integer)
    The offset for pagination.

  - `language` (string)
    Filter by document language (`en`, `ja`, `zh-hans`).

  - `dcpDocumentIdStartsWith` (string)
    Filter by DCP Document ID prefix.

  - `productId` (string)
    Filter by associated product ID.

  - `type` (string)
    Filter by document type. Example values: `Datasheet`, `Datasheet - Short-Form`, `Datasheet Addendum`, `Datasheet Change Notice Guide`, `Manual - Development Tools`, `Manual - Hardware`, `Manual - Software`, `Quick Start Guide`, `General Reliability Literature`, `ICP Test Report`, `Materials Composition Declaration`, `MSDS Document`, `Product Reliability Report`.

  - `subType` (string)
    Filter by document sub-type. 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`.

  - `category` (string)
    Filter by the product category the document is associated with.

  - `documentRevisionDateStart` (string)
    Filter by documents revised on or after this date (YYYY-MM-DD).

  - `documentRevisionDateEnd` (string)
    Filter by documents revised on or before this date (YYYY-MM-DD).

## Response 200 fields (application/json):

  - `data` (array)

  - `data.agileId` (string)
    Primary Agile ID of the document.
    Example: X0185126

  - `data.dcpDocumentId` (string)
    DCP Document ID, if applicable.
    Example: R01TB0099EJ0100

  - `data.url` (string)
    URL to download the document.
    Example: https://www.renesas.com/en/document/oth/ra8p1-group-handbook

  - `data.category` (array)
    Category.

  - `data.category.level` (integer)
    Level of the category:
* 1 - Primary category
* 2 - Secondary subcategory
* 3 - Tertiary subcategory
* 4 - Fourth-level subcategory
    Enum: 1, 2, 3, 4

  - `data.category.title` (string)
    Title of the category.

  - `data.product` (array)
    List of associated products.
    Example: [{"productId":"RL78/G13","title":"Sample Product Title","nid":12345,"uuid":"550e8400-e29b-41d4-a716-446655440000","language":"en"}]

  - `data.product.productId` (string)
    Associated product ID.

  - `data.product.type` (string)
    Type of the associated product.
    Enum: "Product", "Board & Kit", "Software Tool"

  - `data.product.title` (string)
    Associated product title.

  - `data.product.nid` (string)
    Drupal node ID of the product.

  - `data.product.uuid` (string)
    UUID of the product node.

  - `data.product.language` (string)
    Language code of the product node.

  - `data.title` (string)
    Title of the document.
    Example: RA8P1 Group Handbook

  - `data.type` (string)
    Type of the document (e.g., Flyer, App Note).
    Example: Other

  - `data.subType` (array)
    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`.
    Example: ["Driver Package"]

  - `data.fileType` (string)
    File format (e.g., PDF, DOCX).
    Example: PDF

  - `data.secureDocument` (boolean)
    Indicates if the document is secure or restricted.

  - `data.revisionDate` (string)
    Original revision date of the document.

  - `data.wwwUpdateDate` (string)
    Date the document was last updated on the website.

  - `data.language` (string)
    Language of the document (e.g., en, ja, zh-hans).

  - `data.nid` (string)
    Drupal node ID of the document.

  - `data.uuid` (string)
    UUID of the document node.

  - `data.translation` (array)
    List of translations for the document.

  - `data.translation.language` (string)
    Language of the document (e.g., en, ja, zh).

  - `data.translation.dcpDocumentId` (string)
    DCP Document ID of the translation.

  - `data.translation.agileId` (string)
    Agile ID of the translation.

  - `data.translation.title` (string)
    Title of the translation document.

  - `data.translation.href` (string)
    URL to retrieve the translation document.

  - `data.published` (boolean)
    Publication status of the document.

  - `data.featured` (boolean)
    Whether the document is featured or highlighted.

  - `data.relationship` (string)
    Relationship or association type, if any.

  - `data.filename` (string)
    Original filename of the document.

  - `data.disclaimer` (array)
    List of associated disclaimer documents.
    Example: [{"dcpDocumentId":"DISC789012","language":"en","agileId":"X1234567","title":"Standard Product Disclaimer","href":"/documents/DISC789012"},{"dcpDocumentId":"DISC789013","language":"en","agileId":"X1234…

  - `data.disclaimer.dcpDocumentId` (string)
    DCP Document ID of the disclaimer document.

  - `data.disclaimer.agileId` (string)
    Agile ID of the disclaimer document.

  - `data.disclaimer.language` (string)
    Language of the document (e.g., en, ja, zh).

  - `data.disclaimer.title` (string)
    Title of the disclaimer document.

  - `data.disclaimer.href` (string)
    URL to retrieve the disclaimer document.

  - `data.myrenesasDocument` (boolean)
    Is a MyRenesas document.

  - `pagination` (object)

  - `pagination.offset` (integer)
    The actual offset used

  - `pagination.limit` (integer)
    The number of items per page

  - `pagination.total` (integer)
    Total number of items available

  - `pagination.has_more` (boolean)
    Whether there are more items available