Skip to Content
API ReferenceOverview

API Reference

QC Tool provides a RESTful API for integrating with your existing tools and automating workflows.

Base URL

All API endpoints are relative to your QC Tool application URL:

https://your-qctool-url.com/api/

Authentication

All API endpoints require a valid session. Sign in through the QC Tool interface before making API requests.

Authenticated requests include a session cookie automatically when made from a logged-in browser session. For programmatic access, include the Bearer token in the Authorization header:

Authorization: Bearer <your-access-token>

Contact your QC Tool administrator to obtain an API access token for server-to-server integrations.

Response format

All responses return JSON:

{
  "data": { ... },
  "error": null
}

Error responses follow the same structure with data: null and a descriptive error message.

Rate limiting

API requests are rate-limited per user to ensure platform stability. If you receive a 429 Too Many Requests response, wait a moment before retrying.

NotificationsAuthentication