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

Testiny Test Plans API

Curated selections of test cases executed as runs.

Testiny Test Plans API is one of 5 APIs that Testiny 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 6 operations across 3 paths, and defines 4 schemas. It is described by OpenAPI 3.0.4, at version 1.38.0.

Requests are made against a single base URL, https://app.testiny.io/api/v1.

6 operations 3 paths 4 schemas 1 DELETE2 GET2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.4
API Version
1.38.0
Base URL
https://app.testiny.io/api/v1
Authentication
API Key
Contact
Resource Areas
1

Authentication & Security 1

Testiny Test Plans API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-Api-Key (ApiKeyAuth). By default, every request must be authenticated.

  • ApiKeyAuth — API key created in Testiny (Account settings / organization) with fine-grained permissions. Passed as the X-Api-Key request header. Treat the API key like a pa…

Paths & Operations 6

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

Test Plans 6

Curated selections of test cases executed as runs.

GET
/testplan
List test plans
listTestPlans → 200
POST
/testplan
Create a test plan
createTestPlan body → 200
POST
/testplan/find
Find test plans
findTestPlans body → 200
GET
/testplan/{id}
Get a test plan
getTestPlan 1 param → 200
PUT
/testplan/{id}
Update a test plan
updateTestPlan 1 param → 200
DELETE
/testplan/{id}
Delete a test plan
deleteTestPlan 1 param → 200

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are DataReadParams (5 properties), TestPlanInput (3 properties), EntityList (2 properties), Entity (2 properties). Each schema is shown below with its type and property counts.

DataReadParams
object
Query parameters for find endpoints - filtering, ordering, paging, and nested mappings. Computed columns are prefixed with $.
5 properties
Entity
object
A generic Testiny entity envelope. Concrete fields vary by entity type.
2 properties
TestPlanInput
object
3 properties 2 required
EntityList
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

testiny-test-plans-api-openapi.yml Raw ↑

Other APIs Testiny publishes across the network.

Testiny Automation API
Testiny Projects API
Testiny Test Cases API
Testiny Test Runs API