> ## Documentation Index > Fetch the complete documentation index at: https://developer.kodexa.ai/llms.txt > Use this file to discover all available pages before exploring further. # List Data Definitions > Returns a paginated list of Data Definitions. Data definitions (taxonomies) define document structure and extraction rules. ## OpenAPI ````yaml get /api/data-definitions openapi: 3.0.1 info: title: Kodexa AI description: >- The Kodexa platform API provides programmatic access to document processing, intelligent automation, and data extraction capabilities. Use this API to manage organizations, projects, document stores, taxonomies, assistants, and processing pipelines. All endpoints require authentication via API key, Bearer token, or Basic auth. version: 8.0.0 license: name: Commercial url: https://kodexa.ai servers: - url: https://platform.kodexa.ai description: Production - url: http://localhost:8080 description: Local development security: - x-api-key: [] - bearerAuth: [] tags: - name: AI Gateway - name: AccessTokens description: Manage API access tokens for programmatic authentication. - name: Account description: Account management endpoints for the authenticated user. - name: Activities - name: ActivityDocumentFamilies - name: ActivityPlans - name: Agent Runtimes description: Manage agent runtime definitions backed by AWS Bedrock AgentCore. - name: Agent Sessions description: View and manage stateful conversation sessions within agent runtimes. - name: Agents description: Manage agents — instantiated agent runtimes within an org+project. - name: Analytics - name: Applied Knowledge description: Manage applied knowledge instances used during document processing. - name: Applied Knowledge Sets description: Manage applied knowledge set configurations. - name: Assistants description: Manage AI assistants that process and analyze documents within a project. - name: Batch Updates description: Batch document update operations for efficient bulk processing. - name: Channel description: Manage messaging channels for real-time communication within the platform. - name: Channel Types - name: Content Exception description: View and manage content exceptions that occur during document processing. - name: Content Object description: >- Manage content objects — individual files or processing results within a document family. - name: Credit Transactions description: View and manage credit transactions for organization billing. - name: Data Definitions description: >- Manage data definitions (taxonomies) that define document structure and extraction rules. - name: Data Forms description: Manage data form definitions for structured data capture from documents. - name: Data Stores description: Manage data stores for structured data storage. - name: Document Assignments description: Manage document assignments linking document families to users for review. - name: Document Family Statistics description: View statistics about document families including processing metrics. - name: Document Statuses description: >- Manage document status definitions for tracking document processing states. - name: Document Stores description: >- Manage document stores — containers for organizing and processing documents within a project. - name: Document Transitions description: Track state transitions of documents through processing stages. - name: DocumentFamilies description: >- Manage document families — groups of related content objects representing a single logical document. - name: Events description: >- Manage and publish platform events for real-time notifications and integrations. - name: Execution Slices description: View execution slice details within pipeline executions. - name: Executions description: View and manage processing execution records. - name: Intakes description: >- Manage intake configurations for ingesting documents from external sources. - name: Job Document Family Interactions description: View interactions between scheduled jobs and document families. - name: Knowledge Clause Features description: Manage features within knowledge clauses. - name: Knowledge Clauses description: Manage knowledge clauses within knowledge items. - name: Knowledge Feature Types description: Manage knowledge feature type definitions. - name: Knowledge Features description: >- Manage knowledge features representing specific data points within knowledge items. - name: Knowledge Item Types description: Manage knowledge item type definitions. - name: Knowledge Items description: Manage individual knowledge items within knowledge sets. - name: Knowledge Set Snapshots description: Manage snapshots of knowledge sets for versioning and comparison. - name: Knowledge Set Sources description: Manage source references for knowledge sets. - name: Knowledge Sets description: >- Manage knowledge sets — collections of extracted knowledge used for AI-assisted processing. - name: Labels description: >- Manage labels used for categorizing and tagging resources within an organization. - name: Linked Deltas description: Manage linked deltas representing changes between document versions. - name: Messages description: Manage messages within channels. - name: Model Costs - name: Module Runtimes description: Manage module runtime definitions within the orchestrator. - name: Modules - name: Orchestrator Modules description: Manage processing modules for orchestrator pipelines. - name: Organizations description: >- Manage organizations — the top-level tenant in Kodexa. All projects, stores, and resources belong to an organization. - name: Permissions - name: Platform Configuration description: Manage platform-wide configuration settings. - name: Platform Overview description: Platform configuration and overview endpoints. - name: Product Groups description: Manage product groups that bundle related products together. - name: Product Overview description: Browse and manage products available on the Kodexa platform. - name: Product Subscriptions description: Manage product subscriptions linking organizations to products. - name: ProductProjectTemplates description: >- Manage product project templates that define default project configurations. - name: Project Resources - name: Project Status description: Manage project status definitions for tracking project lifecycle. - name: Project Templates description: Manage project templates that define reusable project configurations. - name: Projects description: >- Manage projects within an organization. Projects group related document stores, assistants, tasks, and processing pipelines. - name: Prompts description: Manage prompt templates used by AI assistants for document processing. - name: Purge Items description: Manage purge items for scheduled content cleanup. - name: Recent Executions description: View recent execution history for document processing. - name: Resource Resolution - name: Role Permissions - name: Roles - name: Scheduled Job Executions description: View execution history and results of scheduled jobs. - name: Scheduled Job Schedules description: Manage schedule definitions (cron expressions) for scheduled jobs. - name: Scheduled Jobs description: >- Manage scheduled jobs for automated document processing on a recurring basis. - name: Service Bridges - name: Sessions description: Manage processing sessions for document operations. - name: Step Executions description: View step-level execution details within pipeline executions. - name: Tag Metadata description: Manage tag metadata definitions for document labeling and categorization. - name: Task Groups - name: Task Statuses description: Manage task status definitions for tracking task workflow states. - name: TaskActivity description: Track activity history on tasks, including status changes and comments. - name: TaskDocumentFamilies description: Manage the association between tasks and document families. - name: TaskGroupHistory - name: TaskTemplates description: Manage task templates that define reusable task configurations. - name: Tasks description: >- Manage tasks for document review workflows. Tasks have assignees, statuses, due dates, and can contain document families. - name: Team Members description: Manage team membership assignments. - name: Team Org Assignments - name: Team Project Assignments - name: Teams description: Manage teams for collaborative access control within projects. - name: Triggers - name: Users description: Manage platform user accounts. - name: Workspaces description: Manage workspaces for organizing project resources. externalDocs: description: Kodexa Developer Documentation url: https://developer.kodexa.ai paths: /api/data-definitions: get: tags: - Data Definitions summary: List Data Definitions description: >- Returns a paginated list of Data Definitions. Data definitions (taxonomies) define document structure and extraction rules. operationId: listTaxonomies parameters: - name: page in: query description: Page number (1-indexed). Defaults to 1. schema: type: integer format: int32 example: 1 - name: pageSize in: query description: Number of items per page (1-1000). Defaults to 20, maximum 1000. schema: type: integer format: int32 example: 20 - name: sort in: query description: >- Sort expression as `field,direction`. Direction is `asc` or `desc`. Multiple sort fields can be specified by repeating the parameter. schema: type: string example: name,asc - name: filter in: query description: >- RSQL/FIQL filter expression. Supported operators: `==` (equals), `!=` (not equals), `=like=` (contains), `=in=` (in list), `>` / `>=` / `<` / `<=` (comparison), `=isnull=true` (is null), `=isnull=false` (is not null). Combine with `;` (AND) or `,` (OR). Example: `name=='Acme Corp';status==active` schema: type: string example: name=='Acme Corp' - name: query in: query description: >- Full-text search query matching against the entity's searchable fields. schema: type: string example: invoice responses: '200': description: Page of Taxonomies content: application/json: schema: $ref: '#/components/schemas/PageTaxonomyMetadata' '400': description: Bad Request — the request body or parameters are invalid. '401': description: Unauthorized — authentication is required. '403': description: Forbidden — the authenticated user does not have permission. components: schemas: PageTaxonomyMetadata: type: object properties: content: type: array items: $ref: '#/components/schemas/TaxonomyMetadata' description: Array of TaxonomyMetadata items on this page. first: type: boolean description: Whether this is the first page. last: type: boolean description: Whether this is the last page. number: type: integer format: int32 description: Current page number (0-indexed). numberOfElements: type: integer format: int32 description: Number of items on the current page. pageable: $ref: '#/components/schemas/PageableObject' description: Pagination metadata. size: type: integer format: int32 description: Page size (number of items per page). sort: $ref: '#/components/schemas/SortObject' description: Sort metadata. totalElements: type: integer format: int64 description: Total number of items across all pages. totalPages: type: integer format: int32 description: Total number of pages. description: Paginated response containing TaxonomyMetadata items. TaxonomyMetadata: type: object properties: changeSequence: type: integer format: int32 description: Optimistic locking version number. createdOn: type: string format: date-time description: Timestamp when the taxonomy was created. deleteUserEmail: type: string nullable: true deleteUserId: type: string nullable: true deleted: type: boolean deletedDate: type: string format: date-time nullable: true deprecated: type: boolean description: Whether this taxonomy is deprecated. extensionPackRef: type: string id: type: string description: Unique identifier (UUID) for the taxonomy. example: d3456789-01ab-cdef-2345-678901abcdef metadata: $ref: '#/components/schemas/Taxonomy' name: type: string description: Display name of the taxonomy. example: Invoice Taxonomy organizationId: type: string publicAccess: type: boolean description: Whether the taxonomy is publicly accessible. slug: type: string description: URL-friendly identifier for the taxonomy. example: invoice-taxonomy template: type: boolean description: Whether this taxonomy is a template. type: type: string updatedOn: type: string format: date-time description: Timestamp when the taxonomy was last updated. uuid: type: string description: Secondary UUID identifier. yamlSource: type: string nullable: true description: >- Taxonomy metadata defines document structure and extraction rules (data definitions). PageableObject: type: object properties: offset: type: integer format: int64 description: Offset from the beginning of the result set. pageNumber: type: integer format: int32 description: Current page number (0-indexed). pageSize: type: integer format: int32 description: Number of items per page. paged: type: boolean description: Whether pagination is active. sort: $ref: '#/components/schemas/SortObject' description: Sort metadata. unpaged: type: boolean description: Whether the result is unpaged (all results returned). description: Pagination parameters describing the current page position. SortObject: type: object properties: empty: type: boolean description: Whether the sort is empty (no sort criteria specified). sorted: type: boolean description: Whether sorting is active. unsorted: type: boolean description: Whether results are unsorted. description: Sort metadata describing the current sort state. Taxonomy: type: object properties: checksum: type: string deleteProtection: type: boolean nullable: true description: type: string enabled: type: boolean nullable: true externalDataTaxonomyRefs: type: array items: type: string icon: type: string imageUrl: type: string overviewMarkdown: type: string provider: type: string providerImageUrl: type: string providerUrl: type: string taxonomyType: type: string taxons: type: array items: $ref: '#/components/schemas/Taxon' Taxon: type: object properties: additionContexts: type: array items: type: string cardinality: type: string enum: - ONCE_PER_DOCUMENT - MULTIPLE_PER_DOCUMENT - ONCE_PER_SEGMENT - MULTIPLE_PER_SEGMENT children: type: array items: $ref: '#/components/schemas/Taxon' color: type: string conditionalFormats: type: array items: $ref: '#/components/schemas/TaxonConditionalFormat' dataPath: type: string description: type: string enabled: type: boolean nullable: true eventSubscriptions: type: array items: $ref: '#/components/schemas/TaxonEventSubscription' externalName: type: string generateName: type: boolean nullable: true group: type: boolean nullable: true id: type: string label: type: string lexicalRelations: type: array items: $ref: '#/components/schemas/LexicalRelation' metadataValue: type: string enum: - FILENAME - TRANSACTION_UUID - CREATED_DATETIME - DOCUMENT_LABELS - OWNER_NAME - DOCUMENT_STATUS - PAGE_NUMBER multiValue: type: boolean nullable: true name: type: string nodeTypes: type: array items: type: string notUserLabelled: type: boolean nullable: true nullValue: type: string nullable: type: boolean nullable: true options: type: array items: $ref: '#/components/schemas/TaxonomyOption' order: type: integer format: int32 nullable: true overviewMarkdown: type: string path: type: string properties: $ref: '#/components/schemas/TaxonProperties' nullable: true selectionOptionFormula: type: string selectionOptions: type: array items: $ref: '#/components/schemas/SelectionOption' semanticDefinition: type: string synonyms: type: array items: type: string taxonType: type: string enum: - STRING - DATE - DATE_TIME - NUMBER - BOOLEAN - CURRENCY - URL - EMAIL_ADDRESS - PHONE_NUMBER - SELECTION - PERCENTAGE - FORMULA - DERIVED - SECTION typeFeatures: $ref: '#/components/schemas/TaxonTypeFeatures' nullable: true useSelectionOptionFormula: type: boolean nullable: true userEditable: type: boolean nullable: true validationRules: type: array items: $ref: '#/components/schemas/TaxonomyTaxonValidation' valuePath: type: string enum: - VALUE_OR_ALL_CONTENT - VALUE_ONLY - ALL_CONTENT - DATA_PATH - METADATA - FORMULA - DERIVED - REVIEW TaxonConditionalFormat: type: object properties: background: type: string color: type: string condition: type: string formula: type: string icon: type: string name: type: string properties: type: object additionalProperties: {} style: type: string type: type: string TaxonEventSubscription: type: object properties: dependsOn: type: array items: type: string disabled: type: boolean name: type: string 'on': type: string script: type: string LexicalRelation: type: object properties: type: type: string value: type: string weight: type: number format: double nullable: true TaxonomyOption: type: object properties: aliases: type: array items: type: string default: {} description: type: string developerOnly: type: boolean nullable: true displayProperties: $ref: '#/components/schemas/OptionDisplayProperties' nullable: true falseLabel: type: string featureFlag: type: string groupOptions: type: array items: $ref: '#/components/schemas/TaxonomyOption' hint: type: string label: type: string listDescription: type: string listLabel: type: string listType: type: string name: type: string overviewMarkdown: type: string possibleValues: type: array items: $ref: '#/components/schemas/TaxonomyPossibleValue' properties: $ref: '#/components/schemas/OptionProperties' nullable: true required: type: boolean nullable: true showIf: type: string showOnPopup: type: boolean nullable: true subType: type: string supportArticle: type: string tabName: type: string type: type: string TaxonProperties: type: object properties: alignment: type: string visible: type: boolean nullable: true width: type: integer format: int32 nullable: true SelectionOption: type: object properties: conditionalFormula: type: string description: type: string disabled: type: string hint: type: string hintMarkdown: type: boolean nullable: true id: type: string isConditional: type: boolean nullable: true label: type: string lexicalRelations: type: array items: $ref: '#/components/schemas/LexicalRelation' value: type: string TaxonTypeFeatures: type: object properties: allowTemplating: type: boolean nullable: true cardinality: type: string chunkingStrategy: type: string classificationContent: type: string classificationStrategy: type: string contextHeadLines: type: integer format: int32 nullable: true contextTailLines: type: integer format: int32 nullable: true currencyCode: type: string dateFormat: type: string decimalPlaces: type: integer format: int32 nullable: true embedded: type: boolean nullable: true enableAiFallback: type: boolean nullable: true enableLineFallback: type: boolean nullable: true enablePlanningThinkingMode: type: boolean nullable: true enableStructureReview: type: boolean nullable: true enableStructureReviewThinkingMode: type: boolean nullable: true enableThinkingMode: type: boolean nullable: true expected: type: boolean nullable: true extractionModel: type: string formulaExpression: type: string hierarchyMaxLinesPerCall: type: integer format: int32 nullable: true hierarchyWindowOverlap: type: integer format: int32 nullable: true ignoreNonWords: type: boolean nullable: true imageWidth: type: integer format: int32 nullable: true includeDataElementsInClassificationPrompt: type: boolean nullable: true includeExplanation: type: boolean nullable: true includeImages: type: boolean nullable: true instanceBoundaryThreshold: type: integer format: int32 nullable: true labelDocument: type: boolean nullable: true markdown: type: boolean nullable: true maxChildLines: type: integer format: int32 nullable: true maxPagesFromRerank: type: integer format: int32 nullable: true merge: type: boolean nullable: true mergeInstances: type: boolean nullable: true mergeInstructions: type: string mergeWithAI: type: boolean nullable: true nPages: type: integer format: int32 nullable: true overrideExtractionModel: type: boolean nullable: true planningModel: type: string promptStrategy: type: string raiseExceptionOnAiFallback: type: boolean nullable: true raiseExceptionOnFallback: type: boolean nullable: true rerank: type: boolean nullable: true restrictClassification: type: boolean nullable: true skipExtraction: type: boolean nullable: true structureReview: type: string summarize: type: boolean nullable: true tagPage: type: boolean nullable: true TaxonomyTaxonValidation: type: object properties: conditional: type: boolean nullable: true conditionalFormula: type: string description: type: string detailFormula: type: string disabled: type: boolean nullable: true exceptionId: type: string messageFormula: type: string name: type: string overridable: type: boolean nullable: true ruleFormula: type: string supportArticleId: type: string OptionDisplayProperties: type: object properties: columns: type: integer format: int32 nullable: true rows: type: integer format: int32 nullable: true width: type: integer format: int32 nullable: true TaxonomyPossibleValue: type: object properties: description: type: string label: type: string value: type: string OptionProperties: type: object properties: color: type: string icon: type: string securitySchemes: x-api-key: type: apiKey name: x-api-key in: header description: >- API key for authentication. Create one from the Kodexa platform UI under Settings > Access Tokens. bearerAuth: type: http scheme: bearer bearerFormat: JWT description: JWT Bearer token obtained from the authentication provider. ````