Skip to main content
The TesterArmy API exposes the same projects, tests, groups, and runs you manage in the dashboard. Use it to wire TesterArmy into CI, internal tools, or an agent that cannot use the dashboard.

​
Base URL

All endpoints live under a single origin:
The OpenAPI document is served at /openapi.json and is the source of every endpoint page in this reference.

​
Authentication

Every request carries an API key as a bearer token:
Keys are scoped to the team that created them. A key never sees projects, tests, or runs that belong to another team.
Coding agents can authenticate without a dashboard-issued key by following https://tester.army/auth.md. The MCP server and the CLI call the same API on your behalf.

​
Responses and errors

Responses are JSON. Errors return a JSON body with an error code and a human-readable message, for example { "error": "NoMobileApp", "message": "..." }. Status codes are conventional: 400 for a body that fails validation, 401 for a missing or revoked key, 403 for a resource outside the key’s team, 404 for an unknown id, 409 for a conflict with the current state (for example cancelling a finished run), 422 for a valid request that cannot run (for example no uploaded mobile app or a platform mismatch), and 429 for rate limits or UsageLimitExceeded when the team is out of monthly runs.

​
Where to start

Trigger a test run

Queue a saved test and poll its status.

Signed group webhooks

Fire a whole group from any CI or deployment provider without an API key.

CLI

Drive the same API from a terminal or a coding agent.

MCP server

Connect Claude, Cursor, or any MCP client directly to TesterArmy.