# Get document details URL: /en/docs/api/v1/documents/id/get Last Updated: 2026-07-30T21:15:29.886Z ## 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/{id} **Get document details** Retrieve detailed information about a specific document including metadata, file information, and category details. **Authentication:** Bearer token (`Authorization: Bearer `) **Path parameters:** | Name | Type | Required | Description | |---|---|---|---| | `id` | string (uuid) | Yes | Document ID | **Query parameters:** | Name | Type | Required | Description | |---|---|---|---| | `include_versions` | boolean | No | When set to true (default), include version metadata such as available versions and current version information. | | `version` | string | No | Optional version ID to view. Use `current` to view the promoted version without loading a specific draft. | | `version_status` | string | No | Optional comma-separated list of version statuses to include when loading version metadata (e.g., `draft,published` or `draft,published,archived`). | **Responses:** - `200` - Document details retrieved successfully - `document` (DocumentDetailed (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` (Category (object)) - `id` (string (uuid)): Category identifier - `title` (string): 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 - `status` (enum: draft | published | archived): Document status (only available when versioning is disabled) - `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 - `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 - `file` (object) - `id` (string (uuid)): File identifier - `filename_download` (string): Original filename for download - `filesize` (integer): File size in bytes - `type` (string): MIME type of the file - `title` (string): File title - `url` (string (uri)): URL to access the file with access token - `date_created` (string (date-time)): Document creation timestamp - `date_updated` (string (date-time)): Last update timestamp - `versioning` (boolean): Indicates whether content versioning is enabled for this document - `_version` (object): Metadata about the currently merged version when viewing a draft - `id` (string): Version identifier - `key` (string): Internal Directus key for the version - `name` (string): Human-readable version name - `status` (enum: draft | published | archived) - `is_active` (boolean) - `date_created` (string (date-time)) - `date_updated` (string (date-time)) - `publishedVersions` (array of DocumentVersionSummary (object)): Summary of available published versions (latest first) - `id` (string): Version identifier - `name` (string) - `status` (enum: draft | published | archived) - `is_active` (boolean) - `date_created` (string (date-time)) - `date_updated` (string (date-time)) - `activeVersionId` (string): Identifier of the active (promoted) version when versioning is enabled - `defaultVersionId` (string): Identifier of the default version used for public display - `defaultVersionName` (string): Display name of the default version - `categories` (array of Category (object)): Available categories for dropdown selection - `id` (string (uuid)): Category identifier - `title` (string): 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 - `versions` (array of DocumentVersionSummary (object)): Version summaries when `include_versions=true` - `id` (string): Version identifier - `name` (string) - `status` (enum: draft | published | archived) - `is_active` (boolean) - `date_created` (string (date-time)) - `date_updated` (string (date-time)) - `current_version` (object): The currently selected version (if `version` parameter provided) - `id` (string): Version identifier - `name` (string) - `status` (enum: draft | published | archived) - `is_active` (boolean) - `date_created` (string (date-time)) - `date_updated` (string (date-time)) - `hasPublishedVersion` (boolean): Indicates whether any published versions exist for the document - `error` (string): Error message if any Example (Successful response): ```json { "document": { "id": "doc-123", "title": "Privacy Policy", "description": "Company privacy policy document", "access_level": "public", "issue_date": "2025-01-01", "expiry_date": "2026-01-01", "validity_months": 12, "status": "published", "featured": { "control": true, "resource": false }, "versioning": true, "file": { "id": "file-456", "filename_download": "privacy-policy.pdf", "filesize": 2048576, "type": "application/pdf", "url": "https://directus.example.com/assets/file-456?access_token=..." }, "category": { "id": "cat-789", "title": "Legal", "icon": "gavel", "translations": [ { "locale": "de", "title": "Legal", "description": "Legal documentation" }, { "locale": "fr", "title": "Juridique", "description": "Documentation juridique" } ] } }, "categories": [ { "id": "cat-789", "title": "Legal", "icon": "gavel", "translations": [ { "locale": "de", "title": "Legal" } ] }, { "id": "cat-790", "title": "Technical", "icon": "cpu", "translations": [ { "locale": "de", "title": "Technical" } ] } ], "versions": [ { "id": "ver-001", "name": "Q1 Update", "status": "published", "is_active": true, "date_created": "2025-03-01T10:00:00Z" }, { "id": "ver-002", "name": "Draft revision", "status": "draft", "is_active": false, "date_created": "2025-03-15T09:30:00Z" } ], "current_version": null, "hasPublishedVersion": true, "error": null } ``` - `400` - Bad Request - invalid document ID - `document` (any) - `categories` (array of any) - `error` (object) - `type` (string) - `code` (string) - `message` (string) - `param` (string) - `401` - Unauthorized - `404` - Document not found or access denied - `document` (any) - `categories` (array of any) - `error` (object) - `type` (string) - `code` (string) - `message` (string) - `500` - Internal server error **Code samples:** cURL: ```bash curl -X GET "https://app.orbiqhq.com/api/v1/documents/{id}" \ -H "Authorization: Bearer $ACCESS_TOKEN" \ -H "Content-Type: application/json" ```