Skip to main content

QA Sphere API Overview

Welcome to the QA Sphere API documentation. Our API allows you to programmatically manage test cases, runs, and results in your QA Sphere projects.

Authentication​

All API requests require authentication using an API key. See the Authentication guide to get started.

Base URL​

https://{your-company}.{your-region-code}.qasphere.com/api/public/v0

Response Format​

All responses are returned in JSON format. Successful responses typically include:

  • Status codes in the 2XX range
  • Data specific to the endpoint
  • Pagination information where applicable

Error responses include:

  • Status codes in the 4XX or 5XX range
  • Error message explaining the issue
  • Additional context where available

Rate Limiting​

API requests are rate limited to protect the service and ensure fair usage. The current limits are:

  • 20 requests per second per API key

When you exceed the rate limit, the API returns a 429 Too Many Requests status code with the message:

Too many requests, please try again later.

To avoid hitting rate limits:

  • Implement exponential backoff when retrying failed requests
  • Cache responses where appropriate
  • Batch operations when possible instead of making many individual requests
Getting Started
  1. Create an API key
  2. Test the authentication with the tags endpoint
  3. Explore the available endpoints based on your needs
Need Help?
  • Contact support for assistance
  • Report issues through your account dashboard