Skip to main content
This section provides technical reference documentation for advanced Kodexa features, APIs, and configuration options.

​
Overview

While the main guides focus on practical implementation, this reference section dives deep into:
  • API Specifications: Detailed API behavior and usage patterns
  • Advanced Configuration: Complex settings and options
  • Architecture: System design and implementation details
  • Integration: Advanced integration patterns

​
Available References

Filtering API

Query and filter syntax for listing resources

Options Architecture

Comprehensive guide to the options system architecture

Working with Options

Practical guide to configuring and using options

Advanced Options Features

Advanced options patterns and features

​
API Reference Topics

​
Filtering and Querying

Learn how to filter and query resources using Kodexa’s powerful filtering API: 
GET /api/projects?filter="name: 'test' and createdAt > '2023-01-01'"

Complete Filtering Guide

Operators, comparators, functions, and query patterns

​
Options System

Understand how Kodexa’s flexible options system works:
Learn about the design and structure of the options systemOptions Architecture Guide →

​
When to Use This Section

​
Use API Reference for:

  • Deep Technical Understanding: When you need to understand how something works internally
  • Advanced Configuration: Setting up complex options or filters
  • Troubleshooting: Debugging issues with queries or configurations
  • Integration Development: Building custom integrations or tools

​
Use Main Guides for:

  • Getting Started: Learning basic concepts and workflows
  • Common Tasks: Implementing standard patterns
  • Quick Reference: Looking up syntax or examples
  • Best Practices: Understanding recommended approaches

​
Additional Resources

REST API Documentation

Complete REST API endpoint reference

Python SDK

Python library for Kodexa integration

KDX CLI

Command-line interface reference

Concepts

Core concepts and architecture

​
Contributing to Documentation

Found an issue or want to improve the documentation?
1

Report Issues

Email support@kodexa.com with documentation feedback
2

Request Topics

Let us know what reference material would be helpful
3

Share Examples

Contribute examples from your implementations

​
Finding What You Need

Search First: Use the search bar at the top of the page Browse by Topic: Use the navigation sidebar organized by category Check Related Pages: Look for “Learn More” sections with related links

​
Reading Technical Reference

Start with Overview: Each reference page begins with context Use Examples: Code samples demonstrate practical usage Check Notes: Important details are highlighted in callout boxes Test as You Go: Try examples in your own environment

​
Need Help?

Support

Get help with complex configurations

Documentation

Browse the complete documentation portal