SmartAudit
Back to Documentation

API Reference

Complete API documentation for integrating SmartAudit into your development workflow.

Authentication

SmartAudit uses API keys for authentication. Include your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

Base URL

https://smart-audit.app/api

Endpoints

GET/api/v1/projects

List all projects

Response: Array of project objects
POST/api/v1/projects

Create a new project

Response: Created project object
GET/api/v1/projects/{id}/scan

Get scan results for a project

Response: Scan results with compliance data
POST/api/v1/projects/{id}/scan

Trigger a new compliance scan

Response: Scan job status

Example Response

{
  "id": "proj_123",
  "name": "My Project",
  "status": "active",
  "compliance_score": 95,
  "last_scan": "2024-06-30T10:30:00Z",
  "issues": {
    "critical": 0,
    "high": 2,
    "medium": 5,
    "low": 10
  },
  "created_at": "2024-06-01T09:00:00Z"
}

Rate Limiting

API requests are limited to 1000 requests per hour per API key. Rate limit information is included in response headers.

← Previous: FeaturesNext: Security →