Developer reference

Build on the same
operational foundation.

KAPTRACS exposes REST APIs under /api for every major platform domain. This is an overview of route families and selected operations, rather than an exhaustive API reference. Consult the OpenAPI documentation for your deployed version for exact request and response schemas. Interactive documentation is disabled in production by default.

Authentication

Protected endpoints use the authentication supported by that route, commonly a signed browser session or user API key. Public Knowledge is anonymous; surveys and widgets use their own scoped access flows. Role and record permissions still apply.

REST & JSON

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

Pagination

Pagination and response envelopes vary by endpoint. Where supported, use ?page_size=100&page=2 and follow next_link; check the matching schema before assuming a response shape.

OpenAPI

When enabled, /docs provides parameters, request bodies, response schemas, and interactive testing. Production disables it by default; use an approved development or test environment.

API surface

Endpoints by domain

Entries with an HTTP method identify specific operations. An asterisk (*) groups related routes; it is not part of a request URL.

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
  • GET /api/tickets/{ticket_id}/activity
  • /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

Scheduled work

Group-owned one-time and recurring ticket/task schedules, timezone-aware timing, initial properties, and rendered previews.

  • /api/recurring-work
  • GET /api/recurring-work/options
  • POST /api/recurring-work/preview

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/*
  • GET /api/service-items
  • POST /api/service-items
  • GET /api/service-items/{item_id}
  • PATCH /api/service-items/{item_id}
  • /api/service-items/{item_id}/*
  • /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, assistant operations, confirmed ticket commands, and optional speech input controlled by saved administrator settings.

  • GET /api/ai/status
  • POST /api/ai/test
  • POST /api/ai/models
  • POST /api/ai/tickets/{ticket_id}/summarize
  • /api/ai/tickets/{ticket_id}/assistant
  • /api/ai/commands/*
  • POST /api/voice/transcribe

Knowledge

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

  • /api/knowledge/*
  • /api/portal/knowledge/*
  • /api/admin/knowledge-*
  • /api/public/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
  • POST /api/surveys/respond/view
  • POST /api/surveys/respond/submit
  • /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
  • GET /api/admin/backups/status
  • GET /api/admin/backups/configuration
  • PUT /api/admin/backups/configuration
  • POST /api/admin/backups/run
  • /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
  • GET /api/admin/portal/configuration
  • PATCH /api/admin/portal/configuration
  • /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, use the OpenAPI schemas from the matching deployed version. Where enabled, the interactive UI is available at https://your-kaptracs-host/docs; production disables it by default.

Request an API walkthrough