API Reference

Programmatic access for advanced integrations—most teams use the dashboard instead.

This page is for engineers automating CookieShift alongside your own systems.

Authentication

Send requests with:

http
Authorization: Bearer <your_token>

Use dashboard-issued tokens or API keys where your plan enables them.

Common resources

AreaTypical endpoints
SitesList and register domains
ScansStart crawls and read results
ConfigRead or update banner configuration
ReportsFetch latest compliance snapshots and exports

Exact paths and fields depend on your deployment version—use the interactive API explorer or OpenAPI document your account team provides.

When to use the API

  • CI pipelines that trigger scans after deploy
  • Custom admin panels embedding consent stats
  • Multi-tenant products reselling consent management

For single-site marketing sites, stay with Modules and Consent Setup.

Support

Need an integration design review? Contact support through Help Center in the dashboard and mention your use case.