Testim

Testim Io Test plans API

Search test plans by name, and execute test plans

GitHub OpenAPI

Operations 2

GET /test-plans/search Get test-plans by name #
POST /test-plans/run/{planId} Execute test plans remotely #

Documentation

📖
Documentation
https://docs.tricentis.com/testim/content/administration/api-access.htm
📖
APIReference
https://raw.githubusercontent.com/testimio/public-openapi/main/api.yaml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/testim-io/refs/heads/main/openapi/testim-io-test-plans-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/testim-io-test-plans-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

testim-io-test-plans-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  description: Testim.io Public API for branches and tests
  version: 1.0.0
  title: Testim.io Public Test plans API
  contact:
    email: support@testim.io
servers:
- url: https://api.testim.io
- url: https://api.eu.testim.io
security:
- apiKeyAuth: []
tags:
- name: Test Plans
  description: Search test plans by name, and execute test plans
paths:
  /test-plans/search:
    get:
      summary: Get test-plans by name
      description: List the ID and link of test-plans matching the given name
      tags:
      - Test Plans
      parameters:
      - name: name
        in: query
        required: true
        description: The name of test-plans to search.
        example: plan
        schema:
          type: string
      responses:
        '200':
          description: Test-plan list
          content:
            application/json:
              schema:
                type: object
                properties:
                  testPlans:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          description: Test-plan ID
                        link:
                          type: string
                          description: Link to open test-plan in Testim editor
                  metaData:
                    $ref: '#/components/schemas/metaData'
        '400':
          $ref: '#/components/responses/InvalidOrMissingProperty'
        '401':
          $ref: '#/components/responses/InvalidApiKey'
        '403':
          $ref: '#/components/responses/ApiKeyInsufficientPermissions'
        '429':
          $ref: '#/components/responses/TooManyRequests'
      operationId: getTestPlansSearch
      x-operation-id-source: derived
  /test-plans/run/{planId}:
    post:
      summary: Execute test plans remotely
      tags:
      - Test Plans
      requestBody:
        description: A JSON object containing the execution setup information.
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                branch:
                  description: The name of the branch to execute tests from
                  default: master
                  type: string
                parallel:
                  description: The amount of tests to execute concurrently.
                  default: 1
                  type: number
                params:
                  description: A JSON object (or stringified object) of parameters to add to the execution.
                  anyOf:
                  - type: string
                  - type: object
                  example:
                    paramName: paramValue
                resultLabels:
                  description: Labels to append to the execution result
                  type: array
                  items:
                    type: string
                retries:
                  description: The amount of retries to allow per test.
                  type: number
                timeout:
                  description: The amount of seconds before a test will timeout.
                  default: 600
                  type: number
                turboMode:
                  description: Wether to execute using Turbo Mode or not.
                  default: false
                  type: boolean
                mode:
                  $ref: '#/components/schemas/executionMode'
      parameters:
      - in: path
        name: planId
        required: true
        description: The ID of the test plan to execute
        schema:
          example: PLAN_ID
          type: string
      responses:
        '200':
          description: Execution result
          content:
            application/json:
              schema:
                type: object
                properties:
                  executionId:
                    type: string
                    description: The ID of the new execution
                  metaData:
                    $ref: '#/components/schemas/metaData'
        '400':
          $ref: '#/components/responses/InvalidOrMissingProperty'
        '401':
          $ref: '#/components/responses/InvalidApiKey'
        '403':
          $ref: '#/components/responses/ApiKeyInsufficientPermissions'
        '429':
          $ref: '#/components/responses/TooManyRequests'
      operationId: postTestPlansRunByPlanId
      x-operation-id-source: derived
components:
  schemas:
    executionMode:
      type: string
      enum:
      - extension
      - selenium
    Error:
      type: object
      properties:
        requestId:
          $ref: '#/components/schemas/requestId'
        error:
          type: object
          properties:
            message:
              type: string
            status:
              type: number
              example: 400
          required:
          - status
          - message
      required:
      - string
      - error
    metaData:
      type: object
      properties:
        requestId:
          $ref: '#/components/schemas/requestId'
      required:
      - requestId
    requestId:
      type: string
      example: RQ-HykKrXuMxrp47BRbdWWO-41ed477e-4052-4904-ab98-034f6285e60e
  responses:
    InvalidApiKey:
      description: 'Issue authenticating request: missing or invalid API Key'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    TooManyRequests:
      description: Project or API key rate limiting has been reached
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    ApiKeyInsufficientPermissions:
      description: API key does not have suffiecient permission to make the request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    InvalidOrMissingProperty:
      description: A required property is either missing or it's value is invalid
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    apiKeyAuth:
      type: http
      scheme: bearer
      bearerFormat: PAK-[RANDOM_KEY]