DOCUMENTATION

API Reference

Integrate WebAudit into your workflows with our RESTful API. Programmatically create projects, run audits, and retrieve results.

Get StartedView Endpoints

Authentication

The WebAudit API uses Bearer token authentication. Include your API key in the Authorization header:

Authorization: Bearer your_api_key_here

Getting Your API Key

  1. Log in to your WebAudit dashboard
  2. Navigate to Settings → API
  3. Click "Generate New Key"
  4. Copy and securely store your key

Base URL

https://api.webaudit.dev/v1

All API requests should be made to this base URL. All responses are returned in JSON format.

Endpoints

POST/api/v1/auth/loginAuthenticate and receive access token
POST/api/v1/auth/refreshRefresh access token
GET/api/v1/projectsList all projects in workspace
POST/api/v1/projectsCreate a new project
GET/api/v1/projects/:idGet project details
POST/api/v1/projects/:id/crawlsStart a new audit crawl
GET/api/v1/crawls/:idGet crawl status and results
GET/api/v1/crawls/:id/issuesGet issues from a crawl
GET/api/v1/crawls/:id/pagesGet pages from a crawl
GET/api/v1/reports/:crawlIdGenerate audit report

Rate Limits

Free Plan

100

requests per hour

Pro Plan

1,000

requests per hour

Team Plan

10,000

requests per hour

Enterprise

Custom

contact sales

Need Help?

Can't find what you're looking for? Our team is here to help.

Contact Support