# List documents

URL: /en/docs/api/v1/documents/get
Last Updated: 2026-07-30T21:15:44.940Z

## Description
No description available.

## Available Actions
- Execute GET request
- View request parameters
- View response schema
- Get code examples
- Navigate to related topics
- View step-by-step instructions
- Get best practices

## Content
### GET /api/v1/documents

**List documents**

Retrieve all non-certification documents for the current tenant, with filtering and category information.

**Authentication:** Bearer token (`Authorization: Bearer <token>`)

**Query parameters:**

| Name | Type | Required | Description |
|---|---|---|---|
| `search` | string | No | Search documents by title or description |
| `category` | string (uuid) | No | Filter by category ID |
| `access_level` | enum: public \| restricted \| requires_nda \| internal | No | Filter by access level |
| `status` | enum: draft \| published \| archived | No | Filter by document status |
| `featured` | boolean | No | Filter by documents featured in the Controls overview (`featured.control`). Use `true` for featured documents and `false` for non-featured; values map to the nested `featured.control` flag stored as an object. |

**Responses:**

- `200` - List of documents for the current tenant
  - `documents` (array of Document (object))
    - `id` (string (uuid)): Unique document identifier
    - `title` (string): Document title
    - `slug` (string): Optional URL-friendly slug for public links
    - `description` (string): Document description
    - `description_markdown` (string): Markdown-formatted description
    - `category` (object): Document category information
      - `id` (string (uuid), required): Category identifier
      - `title` (string, required): Localized category name
      - `icon` (string): Optional icon identifier for the category
      - `translations` (array of CategoryTranslation (object)): Available localized labels for the category
        - `locale` (string, required): Normalized locale/language code (e.g., de, fr)
        - `title` (string, required): Localized category title
        - `description` (string): Localized category description if provided
    - `access_level` (enum: public | restricted | requires_nda | internal): Document access level
    - `issue_date` (string (date)): Document issue date in YYYY-MM-DD format
    - `expiry_date` (string (date)): Document expiry date in YYYY-MM-DD format
    - `validity_months` (integer): Document validity period in months
    - `status` (enum: draft | published | archived): Current document status
    - `featured` (object): Featured placement flags for controls/resources sections
      - `control` (boolean): Feature this document in the Controls overview panels
      - `resource` (boolean): Feature this document in the Trust Center Resources panel
    - `show_validity_period_on_card` (boolean): Whether to show validity period on card display
    - `date_created` (string (date-time)): Document creation timestamp
    - `date_updated` (string (date-time)): Last update timestamp

  Example (Successful response):
  
  ```json
  {
  "documents": [
    {
      "id": "doc-123",
      "title": "Privacy Policy",
      "description": "Company privacy policy document",
      "access_level": "public",
      "status": "published",
      "featured": {
        "control": true,
        "resource": false
      },
      "category": {
        "id": "cat-legal",
        "title": "Legal",
        "icon": "gavel",
        "translations": [
          {
            "locale": "de",
            "title": "Legal",
            "description": "Legal documentation"
          },
          {
            "locale": "fr",
            "title": "Juridique",
            "description": "Documentation juridique"
          }
        ]
      }
    }
  ]
}
  ```
- `401` - Unauthorized
- `500` - Internal server error - Failed to load documents

**Code samples:**

cURL:

```bash
curl -X GET "https://app.orbiqhq.com/api/v1/documents" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json"
```

