API Documentation

Authentication: Include your API key as an X-API-Key header or ?api_key= query parameter. Get your API key →

GET /api/v1/projects

Returns a paginated list of approved audit projects.

Query parameters

Parameter	Type	Description
specialty	string	Filter by specialty code (e.g. orthopaedics)
trust	string	Filter by NHS trust code
type	string	audit or qip
q	string	Keyword search
page	integer	Page number (default: 1)
per_page	integer	Results per page (max: 100)

Example request

curl -H "X-API-Key: YOUR_KEY" \
  "https://whichaudit.com/api/v1/projects?specialty=orthopaedics&per_page=10"

Example response

{
  "data": [
    {
      "id": 1,
      "project_name": "VTE Prophylaxis Compliance Audit",
      "project_type": "audit",
      "specialty": "orthopaedics",
      "hospital": "kings-college",
      "year": 2023,
      "keywords": ["VTE", "thromboprophylaxis"],
      "view_count": 142,
      "average_rating": 4.2,
      "verified": true,
      "url": "/audit/vte-prophylaxis-compliance-audit"
    }
  ],
  "meta": { "page": 1, "per_page": 10, "total": 27, "pages": 3 }
}

GET /api/v1/projects/:id

Returns full detail for a single project.

curl -H "X-API-Key: YOUR_KEY" \
  "https://whichaudit.com/api/v1/projects/1"