Get document details
Retrieve detailed information about a specific document including metadata, file information, and category details.
Authorization
bearerAuth AuthorizationBearer <token>
In: header
Path Parameters
id*string
Document ID
Format
uuidQuery Parameters
include_versions?boolean
When set to true (default), include version metadata such as available versions and current version information.
Default
trueversion?string
Optional version ID to view. Use current to view the promoted version without loading a specific draft.
version_status?string
Optional comma-separated list of version statuses to include when loading version metadata (e.g., draft,published or draft,published,archived).
Match
^(draft|published|archived)(,(draft|published|archived))*$Response Body
application/json
application/json
application/json
curl -X GET "https://app.orbiqhq.com/api/v1/documents/550e8400-e29b-41d4-a716-446655440000"{
"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,
"state": "valid",
"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
}{
"document": null,
"categories": [
null
],
"error": {
"type": "invalid_request_error",
"code": "parameter_invalid",
"message": "The document ID provided is not valid.",
"param": "id"
}
}Empty
{
"document": null,
"categories": [
null
],
"error": {
"type": "invalid_request_error",
"code": "not_found",
"message": "Document not found or access denied."
}
}Empty
How is this guide?