TestRail

TestRail is a web-based test case management and QA platform (originally by Gurock, now part of IDERA) for organizing test cases, running test runs and test plans, and recording test results across manual and automated testing. Its HTTP API (v2) exposes projects, suites, sections, cases, runs, plans, tests, results, milestones, configurations, and users so teams can push automated results, create and close test runs, and sync test cases programmatically. The API is available on TestRail Cloud (per-instance host, e.g. https://{instance}.testrail.io) and on self-hosted TestRail Server/Enterprise, and uses the distinctive index.php?/api/v2/ URL style with HTTP Basic authentication (email plus password or API key).

TestRail publishes 11 APIs on the APIs.io network, including Cases API, Configurations API, Milestones API, and 8 more. Tagged areas include Test Runs, Test Management, QA, Test Cases, and Test Results.

TestRail’s developer surface includes authentication, documentation, pricing, and 6 more developer resources.

🌐 Visit website 📡 Source on GitHub
41.8/100 thin ▬ flat Agent 48/100 agent ready Full breakdown ↓
scored 2026-07-27 · rubric v0.5
AccessFreemiumSelf serveFree trial⚡ Free to try
11 APIs
Test RunsTest ManagementQATest CasesTest ResultsTest PlansTestingTest Automation

Kin Score

Kin Score Kin Score How this is scored →
scored 2026-07-27 · rubric v0.5
Composite quality — 41.8/100 · thin
Contract Quality 13.8 / 25
Developer Ergonomics 3.9 / 20
Commercial Clarity 10.0 / 20
Operational Transparency 4.1 / 13
Governance 0.0 / 12
Discoverability 10.0 / 10
Agent readiness — 48/100 · agent ready
Machine-Readable Contract 18 / 18
Agentic Access Contract 15 / 15
MCP Server 0 / 12
Machine-Readable Auth 10 / 10
Idempotency 0 / 9
Stable Error Semantics 0 / 8
Request/Response Examples 0 / 7
Rate-Limit Signaling 7 / 7
Typed Event Surface 0 / 6
Agent Skills 0 / 5
Well-Known Catalog 0 / 4
Consent & Bot Identity 0 / 3
Improve this rating by publishing the missing artifacts — every area above can be raised, and the full rubric is at apis.io/rating/. This rating is computed from github.com/api-evangelist/testrail: open an issue to ask a question, or submit a pull request to add artifacts. Want it done for you? Prioritized profiling — $2,500 →

APIs 11

Individual APIs this provider publishes, each with its own machine-readable definition.

TestRail Cases API

Reusable test cases in the repository.

TestRail Configurations API

Configuration groups (e.g. browsers, OSes) plan entries expand across.

TestRail Milestones API

Releases and deadlines that runs and plans report toward.

TestRail Plans API

Groups of runs, optionally across configurations.

TestRail Projects API

Top-level containers owning suites, cases, runs, plans, and milestones.

TestRail Results API

Recorded outcomes for tests and cases.

TestRail Runs API

Executions of a set of test cases (test runs).

TestRail Sections API

Folder-like grouping of test cases inside a suite.

TestRail Suites API

Collections of test cases within a project.

TestRail Tests API

Instances of a case within a specific run.

TestRail Users API

TestRail user lookup.

Scroll for all 11

Open Collections 1

Open, tool-agnostic API collections (OpenAPI-derived and Bruno).

TestRail API (v2)

OPEN COLLECTION

Pricing Plans 1

Published pricing tiers and plan structures.

Testrail Plans Pricing

4 plans

PLANS

Rate Limits 1

Documented rate limits and quota policies.

Testrail Rate Limits

4 limits

RATE LIMITS

FinOps 1

Cost, billing, and metering signals for API financial operations.

Testrail Finops

FINOPS

Security Posture 1

Authentication, domain security, vulnerability disclosure, and trust-center signals.

Testrail Authentication

http · 1 scheme

SECURITY

Agentic Access 1

Recommended x-agentic-access execution contracts for AI agents.

Testrail Agentic Access

56 operations · 32 acting

56 operations · 32 acting

AGENTIC

Resources

Documentation 1

Reference material describing how the API behaves

Documentation
Documentation

Agent Surfaces 1

MCP servers, agent skills, and machine-readable catalogs

AgenticAccess
AgenticAccess

Access & Security 1

Authentication, authorization, and security posture

Authentication
Authentication

Operate 1

Status, limits, changes, and where to get help

RateLimits
RateLimits

Commercial 3

Pricing, plans, and the legal terms of use

Plans
Plans
 FinOps
FinOps
 Pricing
Pricing

Company 2

The organization behind the API

LinkedIn
LinkedIn
 Website
Website

Source (apis.yml)

apis.yml Raw ↑ 
aid: testrail
url: https://raw.githubusercontent.com/api-evangelist/testrail/refs/heads/main/apis.yml
name: TestRail
kind: company
description: TestRail is a web-based test case management and QA platform (originally by Gurock, now part of IDERA) for organizing
  test cases, running test runs and test plans, and recording test results across manual and automated testing. Its HTTP API
  (v2) exposes projects, suites, sections, cases, runs, plans, tests, results, milestones, configurations, and users so teams
  can push automated results, create and close test runs, and sync test cases programmatically. The API is available on TestRail
  Cloud (per-instance host, e.g. https://{instance}.testrail.io) and on self-hosted TestRail Server/Enterprise, and uses the
  distinctive index.php?/api/v2/ URL style with HTTP Basic authentication (email plus password or API key).
accessModel:
  pricing: freemium
  onboarding: self-serve
  trial: true
  try_now: true
  public: false
  label: Freemium (free trial) · Self-serve signup
  confidence: high
  source:
  - plans
  - authentication
  generated: '2026-07-22'
  method: derived
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/icons/testrail.png
tags:
- Test Runs
- Test Management
- QA
- Test Cases
- Test Results
- Test Plans
- Testing
- Test Automation
created: '2026-07-11'
modified: '2026-07-11'
specificationVersion: '0.19'
apis:
- aid: testrail:testrail-cases-api
  name: TestRail Cases API
  description: Reusable test cases in the repository.
  humanURL: https://support.testrail.com/hc/en-us/articles/7077874763156-Runs
  baseURL: https://{instance}.testrail.io/index.php?/api/v2
  tags:
  - Cases
  properties:
  - type: OpenAPI
    url: openapi/testrail-cases-api-openapi.yml
  - type: APIReference
    url: https://support.testrail.com/hc/en-us/articles/7077874763156-Runs
  - type: PostmanCollection
    url: collections/testrail.postman_collection.json
  - type: OpenCollection
    url: collections/testrail.opencollection.json
  - type: APIReference
    url: https://support.testrail.com/hc/en-us/articles/7077819312404-Results
  - type: APIReference
    url: https://support.testrail.com/hc/en-us/articles/7077292642580-Cases
  - type: APIReference
    url: https://support.testrail.com/hc/en-us/articles/7077990441108-Tests
  - type: APIReference
    url: https://support.testrail.com/hc/en-us/articles/7077711537684-Plans
  - type: APIReference
    url: https://support.testrail.com/hc/en-us/articles/7077792415124-Projects
  - type: APIReference
    url: https://support.testrail.com/hc/en-us/articles/7077936624276-Suites
  - type: APIReference
    url: https://support.testrail.com/hc/en-us/articles/7077083596436-Introduction-to-the-TestRail-API
  - type: APIReference
    url: https://support.testrail.com/hc/en-us/articles/7077723976084-Milestones
- aid: testrail:testrail-configurations-api
  name: TestRail Configurations API
  description: Configuration groups (e.g. browsers, OSes) plan entries expand across.
  humanURL: https://support.testrail.com/hc/en-us/articles/7077874763156-Runs
  baseURL: https://{instance}.testrail.io/index.php?/api/v2
  tags:
  - Configurations
  properties:
  - type: OpenAPI
    url: openapi/testrail-configurations-api-openapi.yml
  - type: APIReference
    url: https://support.testrail.com/hc/en-us/articles/7077874763156-Runs
  - type: PostmanCollection
    url: collections/testrail.postman_collection.json
  - type: OpenCollection
    url: collections/testrail.opencollection.json
  - type: APIReference
    url: https://support.testrail.com/hc/en-us/articles/7077819312404-Results
  - type: APIReference
    url: https://support.testrail.com/hc/en-us/articles/7077292642580-Cases
  - type: APIReference
    url: https://support.testrail.com/hc/en-us/articles/7077990441108-Tests
  - type: APIReference
    url: https://support.testrail.com/hc/en-us/articles/7077711537684-Plans
  - type: APIReference
    url: https://support.testrail.com/hc/en-us/articles/7077792415124-Projects
  - type: APIReference
    url: https://support.testrail.com/hc/en-us/articles/7077936624276-Suites
  - type: APIReference
    url: https://support.testrail.com/hc/en-us/articles/7077083596436-Introduction-to-the-TestRail-API
  - type: APIReference
    url: https://support.testrail.com/hc/en-us/articles/7077723976084-Milestones
- aid: testrail:testrail-milestones-api
  name: TestRail Milestones API
  description: Releases and deadlines that runs and plans report toward.
  humanURL: https://support.testrail.com/hc/en-us/articles/7077874763156-Runs
  baseURL: https://{instance}.testrail.io/index.php?/api/v2
  tags:
  - Milestones
  properties:
  - type: OpenAPI
    url: openapi/testrail-milestones-api-openapi.yml
  - type: APIReference
    url: https://support.testrail.com/hc/en-us/articles/7077874763156-Runs
  - type: PostmanCollection
    url: collections/testrail.postman_collection.json
  - type: OpenCollection
    url: collections/testrail.opencollection.json
  - type: APIReference
    url: https://support.testrail.com/hc/en-us/articles/7077819312404-Results
  - type: APIReference
    url: https://support.testrail.com/hc/en-us/articles/7077292642580-Cases
  - type: APIReference
    url: https://support.testrail.com/hc/en-us/articles/7077990441108-Tests
  - type: APIReference
    url: https://support.testrail.com/hc/en-us/articles/7077711537684-Plans
  - type: APIReference
    url: https://support.testrail.com/hc/en-us/articles/7077792415124-Projects
  - type: APIReference
    url: https://support.testrail.com/hc/en-us/articles/7077936624276-Suites
  - type: APIReference
    url: https://support.testrail.com/hc/en-us/articles/7077083596436-Introduction-to-the-TestRail-API
  - type: APIReference
    url: https://support.testrail.com/hc/en-us/articles/7077723976084-Milestones
- aid: testrail:testrail-plans-api
  name: TestRail Plans API
  description: Groups of runs, optionally across configurations.
  humanURL: https://support.testrail.com/hc/en-us/articles/7077874763156-Runs
  baseURL: https://{instance}.testrail.io/index.php?/api/v2
  tags:
  - Plans
  properties:
  - type: OpenAPI
    url: openapi/testrail-plans-api-openapi.yml
  - type: APIReference
    url: https://support.testrail.com/hc/en-us/articles/7077874763156-Runs
  - type: PostmanCollection
    url: collections/testrail.postman_collection.json
  - type: OpenCollection
    url: collections/testrail.opencollection.json
  - type: APIReference
    url: https://support.testrail.com/hc/en-us/articles/7077819312404-Results
  - type: APIReference
    url: https://support.testrail.com/hc/en-us/articles/7077292642580-Cases
  - type: APIReference
    url: https://support.testrail.com/hc/en-us/articles/7077990441108-Tests
  - type: APIReference
    url: https://support.testrail.com/hc/en-us/articles/7077711537684-Plans
  - type: APIReference
    url: https://support.testrail.com/hc/en-us/articles/7077792415124-Projects
  - type: APIReference
    url: https://support.testrail.com/hc/en-us/articles/7077936624276-Suites
  - type: APIReference
    url: https://support.testrail.com/hc/en-us/articles/7077083596436-Introduction-to-the-TestRail-API
  - type: APIReference
    url: https://support.testrail.com/hc/en-us/articles/7077723976084-Milestones
- aid: testrail:testrail-projects-api
  name: TestRail Projects API
  description: Top-level containers owning suites, cases, runs, plans, and milestones.
  humanURL: https://support.testrail.com/hc/en-us/articles/7077874763156-Runs
  baseURL: https://{instance}.testrail.io/index.php?/api/v2
  tags:
  - Projects
  properties:
  - type: OpenAPI
    url: openapi/testrail-projects-api-openapi.yml
  - type: APIReference
    url: https://support.testrail.com/hc/en-us/articles/7077874763156-Runs
  - type: PostmanCollection
    url: collections/testrail.postman_collection.json
  - type: OpenCollection
    url: collections/testrail.opencollection.json
  - type: APIReference
    url: https://support.testrail.com/hc/en-us/articles/7077819312404-Results
  - type: APIReference
    url: https://support.testrail.com/hc/en-us/articles/7077292642580-Cases
  - type: APIReference
    url: https://support.testrail.com/hc/en-us/articles/7077990441108-Tests
  - type: APIReference
    url: https://support.testrail.com/hc/en-us/articles/7077711537684-Plans
  - type: APIReference
    url: https://support.testrail.com/hc/en-us/articles/7077792415124-Projects
  - type: APIReference
    url: https://support.testrail.com/hc/en-us/articles/7077936624276-Suites
  - type: APIReference
    url: https://support.testrail.com/hc/en-us/articles/7077083596436-Introduction-to-the-TestRail-API
  - type: APIReference
    url: https://support.testrail.com/hc/en-us/articles/7077723976084-Milestones
- aid: testrail:testrail-results-api
  name: TestRail Results API
  description: Recorded outcomes for tests and cases.
  humanURL: https://support.testrail.com/hc/en-us/articles/7077874763156-Runs
  baseURL: https://{instance}.testrail.io/index.php?/api/v2
  tags:
  - Results
  properties:
  - type: OpenAPI
    url: openapi/testrail-results-api-openapi.yml
  - type: APIReference
    url: https://support.testrail.com/hc/en-us/articles/7077874763156-Runs
  - type: PostmanCollection
    url: collections/testrail.postman_collection.json
  - type: OpenCollection
    url: collections/testrail.opencollection.json
  - type: APIReference
    url: https://support.testrail.com/hc/en-us/articles/7077819312404-Results
  - type: APIReference
    url: https://support.testrail.com/hc/en-us/articles/7077292642580-Cases
  - type: APIReference
    url: https://support.testrail.com/hc/en-us/articles/7077990441108-Tests
  - type: APIReference
    url: https://support.testrail.com/hc/en-us/articles/7077711537684-Plans
  - type: APIReference
    url: https://support.testrail.com/hc/en-us/articles/7077792415124-Projects
  - type: APIReference
    url: https://support.testrail.com/hc/en-us/articles/7077936624276-Suites
  - type: APIReference
    url: https://support.testrail.com/hc/en-us/articles/7077083596436-Introduction-to-the-TestRail-API
  - type: APIReference
    url: https://support.testrail.com/hc/en-us/articles/7077723976084-Milestones
- aid: testrail:testrail-runs-api
  name: TestRail Runs API
  description: Executions of a set of test cases (test runs).
  humanURL: https://support.testrail.com/hc/en-us/articles/7077874763156-Runs
  baseURL: https://{instance}.testrail.io/index.php?/api/v2
  tags:
  - Runs
  properties:
  - type: OpenAPI
    url: openapi/testrail-runs-api-openapi.yml
  - type: APIReference
    url: https://support.testrail.com/hc/en-us/articles/7077874763156-Runs
  - type: PostmanCollection
    url: collections/testrail.postman_collection.json
  - type: OpenCollection
    url: collections/testrail.opencollection.json
  - type: APIReference
    url: https://support.testrail.com/hc/en-us/articles/7077819312404-Results
  - type: APIReference
    url: https://support.testrail.com/hc/en-us/articles/7077292642580-Cases
  - type: APIReference
    url: https://support.testrail.com/hc/en-us/articles/7077990441108-Tests
  - type: APIReference
    url: https://support.testrail.com/hc/en-us/articles/7077711537684-Plans
  - type: APIReference
    url: https://support.testrail.com/hc/en-us/articles/7077792415124-Projects
  - type: APIReference
    url: https://support.testrail.com/hc/en-us/articles/7077936624276-Suites
  - type: APIReference
    url: https://support.testrail.com/hc/en-us/articles/7077083596436-Introduction-to-the-TestRail-API
  - type: APIReference
    url: https://support.testrail.com/hc/en-us/articles/7077723976084-Milestones
- aid: testrail:testrail-sections-api
  name: TestRail Sections API
  description: Folder-like grouping of test cases inside a suite.
  humanURL: https://support.testrail.com/hc/en-us/articles/7077874763156-Runs
  baseURL: https://{instance}.testrail.io/index.php?/api/v2
  tags:
  - Sections
  properties:
  - type: OpenAPI
    url: openapi/testrail-sections-api-openapi.yml
  - type: APIReference
    url: https://support.testrail.com/hc/en-us/articles/7077874763156-Runs
  - type: PostmanCollection
    url: collections/testrail.postman_collection.json
  - type: OpenCollection
    url: collections/testrail.opencollection.json
  - type: APIReference
    url: https://support.testrail.com/hc/en-us/articles/7077819312404-Results
  - type: APIReference
    url: https://support.testrail.com/hc/en-us/articles/7077292642580-Cases
  - type: APIReference
    url: https://support.testrail.com/hc/en-us/articles/7077990441108-Tests
  - type: APIReference
    url: https://support.testrail.com/hc/en-us/articles/7077711537684-Plans
  - type: APIReference
    url: https://support.testrail.com/hc/en-us/articles/7077792415124-Projects
  - type: APIReference
    url: https://support.testrail.com/hc/en-us/articles/7077936624276-Suites
  - type: APIReference
    url: https://support.testrail.com/hc/en-us/articles/7077083596436-Introduction-to-the-TestRail-API
  - type: APIReference
    url: https://support.testrail.com/hc/en-us/articles/7077723976084-Milestones
- aid: testrail:testrail-suites-api
  name: TestRail Suites API
  description: Collections of test cases within a project.
  humanURL: https://support.testrail.com/hc/en-us/articles/7077874763156-Runs
  baseURL: https://{instance}.testrail.io/index.php?/api/v2
  tags:
  - Suites
  properties:
  - type: OpenAPI
    url: openapi/testrail-suites-api-openapi.yml
  - type: APIReference
    url: https://support.testrail.com/hc/en-us/articles/7077874763156-Runs
  - type: PostmanCollection
    url: collections/testrail.postman_collection.json
  - type: OpenCollection
    url: collections/testrail.opencollection.json
  - type: APIReference
    url: https://support.testrail.com/hc/en-us/articles/7077819312404-Results
  - type: APIReference
    url: https://support.testrail.com/hc/en-us/articles/7077292642580-Cases
  - type: APIReference
    url: https://support.testrail.com/hc/en-us/articles/7077990441108-Tests
  - type: APIReference
    url: https://support.testrail.com/hc/en-us/articles/7077711537684-Plans
  - type: APIReference
    url: https://support.testrail.com/hc/en-us/articles/7077792415124-Projects
  - type: APIReference
    url: https://support.testrail.com/hc/en-us/articles/7077936624276-Suites
  - type: APIReference
    url: https://support.testrail.com/hc/en-us/articles/7077083596436-Introduction-to-the-TestRail-API
  - type: APIReference
    url: https://support.testrail.com/hc/en-us/articles/7077723976084-Milestones
- aid: testrail:testrail-tests-api
  name: TestRail Tests API
  description: Instances of a case within a specific run.
  humanURL: https://support.testrail.com/hc/en-us/articles/7077874763156-Runs
  baseURL: https://{instance}.testrail.io/index.php?/api/v2
  tags:
  - Tests
  properties:
  - type: OpenAPI
    url: openapi/testrail-tests-api-openapi.yml
  - type: APIReference
    url: https://support.testrail.com/hc/en-us/articles/7077874763156-Runs
  - type: PostmanCollection
    url: collections/testrail.postman_collection.json
  - type: OpenCollection
    url: collections/testrail.opencollection.json
  - type: APIReference
    url: https://support.testrail.com/hc/en-us/articles/7077819312404-Results
  - type: APIReference
    url: https://support.testrail.com/hc/en-us/articles/7077292642580-Cases
  - type: APIReference
    url: https://support.testrail.com/hc/en-us/articles/7077990441108-Tests
  - type: APIReference
    url: https://support.testrail.com/hc/en-us/articles/7077711537684-Plans
  - type: APIReference
    url: https://support.testrail.com/hc/en-us/articles/7077792415124-Projects
  - type: APIReference
    url: https://support.testrail.com/hc/en-us/articles/7077936624276-Suites
  - type: APIReference
    url: https://support.testrail.com/hc/en-us/articles/7077083596436-Introduction-to-the-TestRail-API
  - type: APIReference
    url: https://support.testrail.com/hc/en-us/articles/7077723976084-Milestones
- aid: testrail:testrail-users-api
  name: TestRail Users API
  description: TestRail user lookup.
  humanURL: https://support.testrail.com/hc/en-us/articles/7077874763156-Runs
  baseURL: https://{instance}.testrail.io/index.php?/api/v2
  tags:
  - Users
  properties:
  - type: OpenAPI
    url: openapi/testrail-users-api-openapi.yml
  - type: APIReference
    url: https://support.testrail.com/hc/en-us/articles/7077874763156-Runs
  - type: PostmanCollection
    url: collections/testrail.postman_collection.json
  - type: OpenCollection
    url: collections/testrail.opencollection.json
  - type: APIReference
    url: https://support.testrail.com/hc/en-us/articles/7077819312404-Results
  - type: APIReference
    url: https://support.testrail.com/hc/en-us/articles/7077292642580-Cases
  - type: APIReference
    url: https://support.testrail.com/hc/en-us/articles/7077990441108-Tests
  - type: APIReference
    url: https://support.testrail.com/hc/en-us/articles/7077711537684-Plans
  - type: APIReference
    url: https://support.testrail.com/hc/en-us/articles/7077792415124-Projects
  - type: APIReference
    url: https://support.testrail.com/hc/en-us/articles/7077936624276-Suites
  - type: APIReference
    url: https://support.testrail.com/hc/en-us/articles/7077083596436-Introduction-to-the-TestRail-API
  - type: APIReference
    url: https://support.testrail.com/hc/en-us/articles/7077723976084-Milestones
common:
- type: AgenticAccess
  url: agentic-access/testrail-agentic-access.yml
- type: Authentication
  url: authentication/testrail-authentication.yml
- type: LinkedIn
  url: https://www.linkedin.com/company/testrail
- type: Website
  url: https://www.testrail.com
- type: Documentation
  url: https://support.testrail.com/hc/en-us/articles/7077083596436-Introduction-to-the-TestRail-API
- type: Plans
  url: plans/testrail-plans-pricing.yml
- type: RateLimits
  url: rate-limits/testrail-rate-limits.yml
- type: FinOps
  url: finops/testrail-finops.yml
- type: Pricing
  url: https://www.testrail.com/pricing/
maintainers:
- FN: Kin Lane
  email: kin@apievangelist.com