Download OpenAPI specification:
Filtered public API for Kollengo customers. Use the X-API-KEY header for authentication.
Get all active clauses for an organization. Supports filtering by organization_id and include_history.
| include_history | boolean Include historical versions |
[- {
- "clause_series_id": "string",
- "content": "string",
- "created_at": "string",
- "created_by": "string",
- "effective_date": "string",
- "id": "string",
- "is_active": true,
- "order_num": 0,
- "organization_id": "string",
- "tags": [
- "string"
], - "term_date": "string",
- "title": "string",
- "updated_at": "string",
- "version": 0
}
]Get a specific clause by ID
| id required | string Clause ID |
{- "clause_series_id": "string",
- "content": "string",
- "created_at": "string",
- "created_by": "string",
- "effective_date": "string",
- "id": "string",
- "is_active": true,
- "order_num": 0,
- "organization_id": "string",
- "tags": [
- "string"
], - "term_date": "string",
- "title": "string",
- "updated_at": "string",
- "version": 0
}Get version history for a clause
| id required | string Clause ID |
{- "current_clause": {
- "clause_series_id": "string",
- "content": "string",
- "created_at": "string",
- "created_by": "string",
- "effective_date": "string",
- "id": "string",
- "is_active": true,
- "order_num": 0,
- "organization_id": "string",
- "tags": [
- "string"
], - "term_date": "string",
- "title": "string",
- "updated_at": "string",
- "version": 0
}, - "history": [
- {
- "clause_series_id": "string",
- "content": "string",
- "created_at": "string",
- "created_by": "string",
- "effective_date": "string",
- "id": "string",
- "is_active": true,
- "order_num": 0,
- "organization_id": "string",
- "tags": [
- "string"
], - "term_date": "string",
- "title": "string",
- "updated_at": "string",
- "version": 0
}
]
}Get all contracts for an organization with filtering, sorting, and pagination
| status | string Filter by status (draft, finalized, approved) |
| product_id | string Filter by product ID |
| source_type | string Filter by source type (generated, uploaded) |
| q | string Search by contract name or client |
| sort_by | string Default: "generated_at" Sort field (generated_at, updated_at, status, contract_name) |
| sort_dir | string Default: "desc" Sort direction (asc, desc) |
| limit | integer Default: 20 Number of results per page |
| offset | integer Default: 0 Pagination offset |
{- "contracts": [
- {
- "activity_feed": [
- null
], - "client": "string",
- "contract_name": "string",
- "created_at": "string",
- "feature_ids": [
- "string"
], - "generated_at": "string",
- "generated_by": "string",
- "generated_json": { },
- "id": "string",
- "optional_toggles": { },
- "organization_id": "string",
- "product_id": "string",
- "product_name": "string",
- "review_completed_at": "string",
- "review_started_at": "string",
- "sale_date": "string",
- "source_type": "string",
- "status": "string",
- "template_version_used": 0,
- "updated_at": "string",
- "version": 0
}
], - "total": 0
}Generate a contract from product and features configuration
| organization_id required | string Organization ID |
Contract generation request
object | |
| client | string |
| contract_name | string |
object | |
| feature_ids | Array of strings |
object | |
| product_id required | string |
| sale_date | string Optional RFC3339 timestamp or YYYY-MM-DD format, defaults to current time |
{- "clause_values": {
- "property1": { },
- "property2": { }
}, - "client": "string",
- "contract_name": "string",
- "data": { },
- "feature_ids": [
- "string"
], - "optional_toggles": { },
- "product_id": "string",
- "sale_date": "string"
}{- "contract": {
- "activity_feed": [
- null
], - "client": "string",
- "contract_name": "string",
- "created_at": "string",
- "feature_ids": [
- "string"
], - "generated_at": "string",
- "generated_by": "string",
- "generated_json": { },
- "id": "string",
- "optional_toggles": { },
- "organization_id": "string",
- "product_id": "string",
- "review_completed_at": "string",
- "review_started_at": "string",
- "sale_date": "string",
- "source_type": "string",
- "status": "string",
- "template_version_used": 0,
- "updated_at": "string",
- "version": 0
}, - "json": { }
}Returns clause variables and template ID without creating a contract
Contract generation request
object | |
| client | string |
| contract_name | string |
object | |
| feature_ids | Array of strings |
object | |
| product_id required | string |
| sale_date | string Optional RFC3339 timestamp or YYYY-MM-DD format, defaults to current time |
{- "clause_values": {
- "property1": { },
- "property2": { }
}, - "client": "string",
- "contract_name": "string",
- "data": { },
- "feature_ids": [
- "string"
], - "optional_toggles": { },
- "product_id": "string",
- "sale_date": "string"
}{- "clause_variables": [
- {
- "clause_id": "string",
- "clause_title": "string",
- "name": "string"
}
], - "template_id": "string"
}Get a specific contract by ID
| id required | string Contract ID |
{- "contract": {
- "activity_feed": [
- null
], - "client": "string",
- "contract_name": "string",
- "created_at": "string",
- "feature_ids": [
- "string"
], - "generated_at": "string",
- "generated_by": "string",
- "generated_json": { },
- "id": "string",
- "optional_toggles": { },
- "organization_id": "string",
- "product_id": "string",
- "review_completed_at": "string",
- "review_started_at": "string",
- "sale_date": "string",
- "source_type": "string",
- "status": "string",
- "template_version_used": 0,
- "updated_at": "string",
- "version": 0
}, - "features": [
- {
- "created_at": "string",
- "description": "string",
- "id": "string",
- "is_active": true,
- "name": "string",
- "organization_id": "string",
- "product_id": "string",
- "updated_at": "string"
}
], - "product": {
- "created_at": "string",
- "description": "string",
- "id": "string",
- "is_active": true,
- "name": "string",
- "organization_id": "string",
- "template_id": "string",
- "updated_at": "string"
}
}Generate a PDF for a contract by calling the Fastify service with LiquidJS template
| id required | string Contract ID |
Form data with template field values
| form_data | object |
{- "form_data": { }
}Get comprehensive contract report with all metadata and statistics
| id required | string Contract ID |
{- "accepted_suggestions": 0,
- "clause_values": {
- "property1": { },
- "property2": { }
}, - "contract_id": "string",
- "contract_name": "string",
- "created_at": "string",
- "customer_name": "string",
- "days_in_redlining": 0,
- "features": [
- {
- "id": "string",
- "name": "string"
}
], - "num_comments": 0,
- "num_suggestions": 0,
- "participants": [
- {
- "email": "string",
- "id": "string",
- "name": "string",
- "role": "string"
}
], - "pending_approvers": [
- {
- "email": "string",
- "name": "string",
- "user_id": "string"
}
], - "pending_suggestions": 0,
- "products": [
- {
- "id": "string",
- "name": "string"
}
], - "review_started_at": "string",
- "status": "string",
- "template_data": { }
}Get all features for the organization (independent of products)
[- {
- "created_at": "string",
- "description": "string",
- "id": "string",
- "is_active": true,
- "name": "string",
- "organization_id": "string",
- "product_id": "string",
- "updated_at": "string"
}
][- {
- "created_at": "string",
- "description": "string",
- "id": "string",
- "is_active": true,
- "name": "string",
- "organization_id": "string",
- "template_id": "string",
- "updated_at": "string"
}
]Get a specific product by ID
| id required | string Product ID |
{- "created_at": "string",
- "description": "string",
- "id": "string",
- "is_active": true,
- "name": "string",
- "organization_id": "string",
- "template_id": "string",
- "updated_at": "string"
}Get all features associated with a product
| id required | string Product ID |
[- {
- "feature": {
- "created_at": "string",
- "description": "string",
- "id": "string",
- "is_active": true,
- "name": "string",
- "organization_id": "string",
- "product_id": "string",
- "updated_at": "string"
}, - "feature_id": "string",
- "product_id": "string"
}
]Get the current redlines JSON for a contract (requires organization membership)
| id required | string Contract ID |
{- "allowed_emails": [
- "string"
], - "allowed_recipients": [
- {
- "email": "string",
- "name": "string"
}
], - "contract_id": "string",
- "created_at": "string",
- "expires_at": "string",
- "id": "string",
- "is_enabled": true,
- "redlines": {
- "activity": [
- {
- "action": "string",
- "at": "string",
- "by": "string",
- "id": "string",
- "threadId": "string",
- "type": "string"
}
], - "documentVersion": 0,
- "participants": [
- {
- "email": "string",
- "id": "string",
- "name": "string",
- "role": "string"
}
], - "schemaVersion": 0,
- "threads": [
- {
- "anchor": {
- "end": 0,
- "kind": "string",
- "quote": "string",
- "start": 0
}, - "approvals": [
- {
- "approved_at": "string",
- "approver_id": "string",
- "status": "string"
}
], - "author": {
- "email": "string",
- "id": "string",
- "name": "string"
}, - "changes": [
- {
- "content": null,
- "html": "string",
- "op": "string",
- "range": {
- "end": 0,
- "start": 0
}, - "text": "string"
}
], - "clauseId": "string",
- "clause_approvers_required": true,
- "createdAt": "string",
- "id": "string",
- "isInternal": true,
- "messages": [
- {
- "author": {
- "email": "string",
- "id": "string",
- "name": "string"
}, - "createdAt": "string",
- "id": "string",
- "mentions": [
- "string"
], - "text": "string"
}
], - "required_approvers": [
- "string"
], - "resolved": true,
- "status": "string",
- "type": "string",
- "updatedAt": "string"
}
], - "version": 0
}, - "token": "string",
- "updated_at": "string",
- "version": 0
}[- {
- "description": "string",
- "engine": "string",
- "id": "string",
- "is_active": true,
- "name": "string",
- "organization_id": "string",
- "production_content": "string",
- "production_version": 0,
- "staging_content": "string",
- "staging_updated_at": "string",
- "staging_updated_by": "string",
- "staging_version": 0
}
]Get a specific template by ID
| id required | string Template ID |
{- "description": "string",
- "engine": "string",
- "id": "string",
- "is_active": true,
- "name": "string",
- "organization_id": "string",
- "production_content": "string",
- "production_version": 0,
- "staging_content": "string",
- "staging_updated_at": "string",
- "staging_updated_by": "string",
- "staging_version": 0
}Extract all variables from a liquid template
| id required | string Template ID |
{- "data": {
- "dataFields": [
- {
- "elementId": "string",
- "elementType": "string",
- "field": "string",
- "required": true,
- "type": "string"
}
], - "templateId": "string"
}, - "success": true
}