For AI agents: the docs index is at https://developers.katalon.com/llms.txt. Append .md to any documentation page URL to get its markdown version.

Jump to Content

API Reference Developer Guides Recipes Documentation Community Academy Platform

Developer Guides Recipes API Reference

API Reference Developer Guides Recipes Documentation Community Academy Platform Log In

API Reference

True Platform API (v2)

Project setup
Organizations
Test management
Datasets
Test suite collections
- List test suite collectionsget
- List test suite collection entriesget
Tasks
- Get a taskget
- Cancel a taskpost
System field options
Tags
Project variables
- List project variablesget
- List cases that use a variableget
Test plans
- Get the latest test planget
External issues
Execution
Manual iterations
TestCloud apps
TestCloud agents
TestCloud tunnels
TestCloud features
- List TestCloud execution featuresget
TestCloud executions
- List TestCloud executionsget
TestCloud live sessions
- Create a desktop live-session recordpost
Test runs
Test results
- List project test resultsget
- List failure categoriesget
Logs and reports
- List uploaded files for a test runget
- Get an uploaded fileget
Reports and insights
ALM integration
Schedules

True Platform API (v1)

v1 API overview
Katalon True Platform API
Search test-related objects via API
- Get test object via searchpost
Files and visual checkpoints
- File handling
  - Download a file by file-handle IDget
  - Allocate file upload URLsget
- Visual checkpoints
Katalon TestCloud API (legacy)
- Mobile Apps

Powered by

Project setup

Find projects and set up what tests run against: AUTs, their environments and project links, custom fields, and stored files.

Updated 2 days ago

Did this page help you?

Updated 2 days ago

Did this page help you?