API v1 ReferenceDocuments
List documents
Retrieve all non-certification documents for the current tenant, with filtering and category information.
Authorization
bearerAuth AuthorizationBearer <token>
In: header
Query Parameters
search?string
Search documents by title or description
category?string
Filter by category ID
Format
uuidaccess_level?string
Filter by access level
Value in
"public" | "restricted" | "requires_nda" | "internal"state?string
Filter by document state
Value in
"valid" | "pending" | "expired" | "inactive"featured?boolean
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.
Response Body
application/json
curl -X GET "https://app.orbiqhq.com/api/v1/documents?search=privacy+policy&category=550e8400-e29b-41d4-a716-446655440000&access_level=public&state=valid&featured=true"{
"documents": [
{
"id": "doc-123",
"title": "Privacy Policy",
"description": "Company privacy policy document",
"access_level": "public",
"state": "valid",
"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"
}
]
}
}
]
}Empty
Empty
How is this guide?