Developer reference

Build on the same
operational foundation.

KAPTRACS exposes REST APIs under /api for every major platform domain. Use this map to understand the surface, then use the interactive OpenAPI UI on your running instance for authoritative schemas and live requests.

Explore endpoints Ask about API access

Authentication

Use a signed browser session or a lifecycle-managed user API key. Authorization is always scoped by the caller's KAPTRACS role and record access.

REST & JSON

Send and receive JSON over HTTPS. Resource routes live below /api; protected files use authenticated download routes.

Pagination

List endpoints conventionally accept ?page_size=100&page=2 and return next_link when another page is available.

OpenAPI

Visit /docs on a running KAPTRACS backend for exact parameters, request bodies, response schemas, and interactive testing.

API surface

Endpoints by domain

Authentication & sessions

Sign-in, browser sessions, API credentials, current-user context, and session revocation.

  • POST /api/token
  • POST /api/session/login
  • POST /api/session/refresh
  • POST /api/session/logout
  • GET /api/sessions
  • GET /api/me

Users & directory

Unified user directory, agents, groups, status definitions, and administrative membership controls.

  • GET /api/users
  • GET /api/users/me
  • GET /api/agents
  • GET /api/agent-groups
  • GET /api/statuses
  • /api/admin/users
  • /api/admin/group-collections
  • /api/admin/requester-groups

Tickets

Ticket lifecycle, conversations, activity, sharing, related tasks, attachments, and saved views.

  • /api/tickets
  • /api/tickets/{ticket_id}/conversations
  • /api/tickets/{ticket_id}/activities
  • /api/tickets/{ticket_id}/shares
  • /api/tickets/{ticket_id}/tasks
  • /api/ticket-views/*

Tasks & projects

Standalone and associated tasks, project membership, dependencies, files, conversations, and timelines.

  • /api/tasks
  • /api/projects
  • /api/projects/{project_id}/tasks
  • /api/projects/{project_id}/files

Change management

Change requests, lifecycle transitions, approvals, CAB, routing, calendars, tasks, PIR, and relationships.

  • /api/changes
  • /api/changes/{change_id}/*
  • /api/change-management/*

Problems & assets

Problem investigation and Asset Management Lite inventory with operational record relationships.

  • /api/problems
  • /api/problems/{problem_id}/*
  • /api/assets
  • /api/assets/{asset_id}/*

Service catalog

Requester catalog access, administrative Service Item authoring, conditional forms, and secure requested forms.

  • /api/catalog/*
  • /api/admin/service-items/*
  • /api/requested-forms/*

Workflows & credentials

Workflow definitions and versions, execution support, visual automation, and integration credentials.

  • /api/workflows
  • /api/workflow/*
  • /api/workflow-definitions
  • /api/credentials

AI

Provider health, model discovery, ticket summarization, and assistant operations controlled by feature flags.

  • GET /api/ai/status
  • POST /api/ai/test
  • GET /api/ai/models
  • POST /api/ai/tickets/{ticket_id}/summarize
  • /api/ai/tickets/{ticket_id}/assistant

Knowledge

Spaces, folders, articles, revisions, localized content, portal access, proposals, and publishing administration.

  • /api/knowledge/*
  • /api/portal/knowledge/*
  • /api/admin/knowledge-*

Reports & dashboards

Saved reports, widget data, exports, subscriptions, delivery history, sharing, and dashboard workspaces.

  • /api/reports/*
  • /api/dashboards/*

Notifications & mail

In-app notifications, preferences, live updates, mailbox identities, inbound processing, and announcements.

  • /api/notifications/*
  • /api/mailboxes/*
  • /api/announcements/*

Surveys, widgets & templates

Survey authoring and responses, embeddable Help Widgets, and reusable agent response templates.

  • /api/admin/surveys
  • /api/surveys/respond
  • /api/admin/help-widgets
  • /api/widget/v1
  • /api/response-templates

Operations

Audit, health, backups, releases, entitlements, readiness, and liveness for production operations.

  • /api/admin/audit
  • /api/admin/operations/health
  • /api/admin/backups
  • /api/admin/releases
  • /api/admin/entitlements
  • GET /api/health/live
  • GET /api/health/ready

Administration

Assignment routing, identity providers, portal configuration, and system-wide settings.

  • /api/admin/nonform-rules
  • /api/admin/form-rules
  • /api/admin/form-rule-exceptions
  • /api/admin/identity-providers
  • /api/admin/portal
  • /api/admin/system-settings

Field Manager, i18n & data

Taxonomy, languages, priorities, user fields, generated catalogs, and custom data tables.

  • /api/categories*
  • /api/languages
  • /api/priorities
  • /api/statuses
  • /api/user-fields
  • /api/i18n/catalogs
  • /api/data-tables

Source of truth

Precise schemas live with your deployment.

This public reference maps the supported API domains without exposing a customer environment. Because KAPTRACS is actively developed and can be self-hosted, the OpenAPI UI at https://your-kaptracs-host/docs is authoritative for the version you run.

Request an API walkthrough