Catalio Documentation
Comprehensive guides and references for AI-powered requirements management
Get Started in 3 Steps
Everything you need to begin using Catalio effectively
Documentation
Browse documentation by category
Getting Started
Essential guides to get you up and running with Catalio's core features and workflows
Api Guides
Documentation and guides for api guides
JSON:API Overview & Getting Started
Complete overview of Catalio's JSON:API implementation including authentication, resource endpoints, common patterns, and OpenAPI documentation.
API Authentication & Authorization
Complete guide to authenticating with the Catalio API using OAuth 2.0, JWT tokens, and managing API keys with proper security practices.
Requirements API Reference
Complete API reference for managing requirements including CRUD operations, filtering, sorting, relationships, and AI-powered features.
API Best Practices & Patterns
Learn best practices for building production-ready integrations with the Catalio API including error handling, retries, caching, and performance optimization.
Core Concepts
Essential concepts for understanding how Catalio organizes your requirements and business knowledge
What is a Requirement?
Learn how Catalio structures business requirements using user story format with AI-powered features
Who Are Your Users? Understanding Personas
Define user roles and stakeholders to create targeted, user-centered requirements
Defining Acceptance Criteria with Use Cases
Create testable scenarios using Gherkin format to validate your requirements
Validating Requirements with Test Cases
Create comprehensive test strategies to ensure requirements are implemented correctly
Orchestrating Requirements with Processes
Organize requirements into sequential workflows using templates and deployment tracking
Mapping Requirements to External Systems
Track how requirements connect to Salesforce, ServiceNow, and other enterprise platforms
Organizing Your Implementers with Teams
Group users by function or domain to manage requirement implementation and accountability
Multi-Tenant Structure: Organizations
Understand how Catalio isolates data and manages access across enterprise boundaries
Managing Team Members: Users and Roles
Control access and permissions through user roles and authentication providers
What Are Policies? Governance and Compliance Framework
Learn how organizational policies constrain requirements, enforce compliance, manage risk, and ensure standards across your SDLC workflow
Integrations
Connect Catalio with your existing enterprise platforms and development tools
ServiceNow Integration
Integrate Catalio with ServiceNow to connect requirements management with IT service management, change requests, and incident tracking.
Jira Integration
Connect Catalio requirements to Jira epics, user stories, and tasks for seamless agile development workflow and bi-directional synchronization.
GitHub Integration
Connect Catalio to GitHub to link requirements with issues, pull requests, and commits for complete development traceability.
Building Custom Integrations
Learn how to build custom integrations with Catalio using REST API, webhooks, and OAuth for connecting proprietary systems and unique business workflows.
Setting Up LLM API Keys for AI Features
Configure Large Language Model API keys to enable Catalio's AI-powered features including requirement generation, analysis, and intelligent suggestions.
Use Cases
Real-world scenarios showing how Catalio accelerates enterprise platform transformations
Enterprise Software Development
How enterprise software teams use Catalio to manage complex requirements across distributed teams, integrate with development tools, and maintain traceability throughout the SDLC.
Regulated Industries: Healthcare, Finance & Pharma
How organizations in regulated industries use Catalio to maintain compliance, manage validation documentation, and ensure traceability for FDA, HIPAA, SOX, and other regulatory requirements.
Product Management & Roadmap Planning
How product managers use Catalio to capture customer needs, prioritize features, plan roadmaps, and communicate with stakeholders while maintaining alignment between vision and execution.
Consulting & Systems Integration Projects
How consulting firms and systems integrators use Catalio to manage client requirements, coordinate implementation projects, and deliver successful enterprise software deployments.
SaaS Platform Configuration Management
How business teams manage SaaS platform configurations, maintain traceability across Salesforce, HubSpot, and NetSuite customizations, and ensure business process integrity through comprehensive configuration documentation.
Can't find what you're looking for?
Use our instant search to find answers across all documentation