listDocumentTypes
List accessible document types
Retrieve the paginated list of document types the user can access, with optional search by name, code, or description. Includes:
- Documents created by the user
- Documents from the user's organizations
- Public published documents (isPublic=true and isDraft=false)
Supports pagination and search.
Authorization
ApiKeyAuth Bearer token for API authentication
In: header
Query Parameters
Search by name, code, or description of the document type
Page number (starts at 1)
11 <= valueNumber of results per page (maximum 100)
201 <= value <= 100Response Body
application/json
application/json
application/json
application/json
application/json
application/json
getDocumentType GET
Retrieve the full definition of a single document type by its ID, including its JSON Schema, prompt hints, and conversion settings. Use this endpoint to inspect how a document type extracts data, or to export a type's configuration so you can recreate it elsewhere with `POST /api/document-types` or update it with `PUT /api/document-types/{id}`. **Access rules** — the API key's user can read a document type when any of these hold: - The type is **public and published** (`isPublic: true`, `status: PUBLISHED`). - The user **created** the type. - The user is a **member of the organization** that owns the type. If none apply, the endpoint responds with `404` (the existence of private types is never disclosed). Only public, reusable fields are returned — internal metadata such as the owning organization or creator is omitted.
updateDocumentType PUT
Update an existing document type's schema, name, description, prompt hints, conversion spec, or validation rules. All fields are optional. **Permissions:** - Non-admin users can only update document types they created - Non-admin users cannot set `isPublic` to `true` - `codeType` is immutable and will be ignored if provided When `isDraft` changes, the `status` field is automatically updated. A version snapshot is created with the state before the update.