Shiny Go Clean Developer & Agent Resources
Shiny Go Clean exposes one narrow public integration: customer-authorized cleaning quote and contact requests for Madison and nearby Dane County communities. It is not a general scheduling, customer-record, cleaner, or payments API.
Safe quickstart
Start by reading the OpenAPI description. Do not submit a test lead. Use the POST endpoint only when a real customer has explicitly asked Shiny Go Clean to contact them.
curl -H "Accept: application/json" \
https://www.shinygoclean.com/openapi.jsonNo API key is required. Do not send an Authorization header. Customer contact details and explicit authorization are required for lead submission.
Official resources
OpenAPI 3.1 specification
Machine-readable contract for the versioned Lead Intake API.
/openapi.jsonAPI documentation
Request fields, structured errors, rate limits, and lifecycle policy.
/api-docsAuthentication guide
Anonymous access rules and customer-authorization requirements.
/auth.mdRFC 9727 API catalog
Predictable machine discovery for the supported API surface.
/.well-known/api-catalogAgent instructions
When to use Shiny Go Clean and how to route customer requests.
/llms.txtVersioning and deprecation
The supported endpoint is /api/v1/leads. Breaking changes require a new URL version.
The existing /api/leads path remains available for current website forms and points agents to its successor through response headers.
No removal date is currently scheduled.
Rate limits
Submissions are limited to 10 requests per minute per client at the serving edge. Responses include standard rate-limit headers.
A 429 response includes Retry-After and an application/problem+json body.
Current product boundaries
- No public sandbox.
- No official CLI, SDK, MCP server, OAuth service, or webhook product.
- No API access to customer, cleaner, schedule, payment, or Fieldd records.
- No test, duplicate, unsolicited, or fabricated leads.
Integration questions: contact Shiny Go Clean.