Testably API Reference
Automate your QA workflow with our RESTful API. Push test results, manage cases, and integrate with any tool.
API authentication
All API requests require a project-scoped API token passed in the Authorization header.
curl -H "Authorization: Bearer YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
https://api.testably.app/v1/test-casesRate Limiting
60 requests per minute per token. Returns 429 when exceeded.
Error Responses
JSON with error and message fields. Standard HTTP status codes.
API categories
Explore our API endpoints organized by resource type.
Authentication
POSTGenerate and manage API tokens. Create project-scoped tokens for secure CI/CD access.
Test Cases
CRUDCreate, read, update, delete test cases. List with filters, manage folders and tags.
Test Runs
POSTCreate test runs, upload results, and query run status. Bulk result upload for CI/CD.
Test Results
PUTUpdate individual results or bulk upload from automated test suites.
Projects
GETList projects and retrieve project settings and configuration.
Milestones
CRUDCreate, read, and update milestones. Link test runs to release targets.
CI/CD Results Upload
POSTUpload test results from CI/CD pipelines. Supports JSON and JUnit XML formats. Used by @testably.kr/playwright-reporter, cypress-reporter, jest-reporter SDKs.
Upload Logs
GETRetrieve recent CI/CD upload history. View upload status, result counts, and error details for each pipeline run.
Webhooks
POSTSubscribe to events (run completed, test failed, etc.). Configure payload schemas.
CI/CD integration
Push automated test results from your pipeline with a single API call.
- name: Upload test results to Testably
run: |
curl -X POST https://api.testably.app/v1/runs/upload \
-H "Authorization: Bearer ${{ secrets.TESTABLY_TOKEN }}" \
-H "Content-Type: application/json" \
-d '{
"project_id": "proj_abc123",
"run_name": "CI Build #${{ github.run_number }}",
"results": "junit-results.xml"
}'Browse the full API reference by clicking any category above, or visit the Authentication guide to get started.