Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Testim Io Test plans API

Search test plans by name, and execute test plans

Testim Io Test plans API is one of 7 APIs that Testim Io publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Test plans. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 2 operations across 2 paths, and defines 4 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.

Requests are made against 2 base URLs: https://api.testim.io, https://api.eu.testim.io.

2 operations 2 paths 4 schemas 1 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0.0
Base URL
https://api.testim.io
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Testim Io Test plans API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (PAK-[RANDOM_KEY]) (apiKeyAuth). By default, every request must be authenticated.

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 1 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Test plans 2

Search test plans by name, and execute test plans

GET
/test-plans/search
Get test-plans by name
1 param → 200400401403429
POST
/test-plans/run/{planId}
Execute test plans remotely
1 param body → 200400401403429

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are Error (2 properties), metaData (1 property). Each schema is shown below with its type and property counts.

executionMode
string
requestId
string
metaData
object
1 property 1 required
Error
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

testim-io-test-plans-api-openapi.yml Raw ↑

Other APIs Testim Io publishes across the network.

Testim Io Branches API
Testim Io Executions API
Testim Io Labels API
Testim Io Mobile Applications API
Testim Io Suites API
Testim Io Tests API