API & Agent Discovery Documentation

This page documents the machine-readable interfaces Happy Housekeepers publishes for
search engines, AI agents, and developers. Everything below is read-only and public —
nothing here requires authentication.

WordPress REST API Root

The standard WordPress REST API root, listing all registered routes on this site.

  • Endpoint: GET /wp-json/
  • Format: application/json

Happy Housekeepers Services API

A normalized, agent-friendly listing of our cleaning services. Custom fields and
categories are included automatically when the underlying service listing defines them.

  • Endpoint: GET /wp-json/happyhousekeepers/v1/services
  • Format: application/json

Query parameters

Parameter Type Default Description
per_page integer 50 Maximum results (1–100).
category string Filter by taxonomy term slug.
search string Search service title and content.

Response fields

Field Description
id Service listing ID.
title Service name.
excerpt Plain-text summary.
url Public page for this service.
updated_at ISO 8601 last-modified timestamp.
categories Object of taxonomy slug → array of term names.
request_quote_url Where to request a quote for any service.
custom_fields Optional. Any additional fields explicitly registered as public on this service type.

Example request

curl "https://happyhousekeepers.com/wp-json/happyhousekeepers/v1/services?per_page=5"

Example response

{
  "source": "https://happyhousekeepers.com/wp-json/wp/v2/services",
  "count": 1,
  "services": [
    {
      "id": 42,
      "title": "House Cleaning",
      "excerpt": "Regular and one-time residential cleaning.",
      "url": "https://happyhousekeepers.com/services/house-cleaning/",
      "updated_at": "2026-07-01T09:00:00-06:00",
      "categories": { "service_type": ["Residential"] },
      "request_quote_url": "https://happyhousekeepers.com/request-a-quote/"
    }
  ]
}

WordPress Posts API

Standard WordPress blog post collection.

  • Endpoint: GET /wp-json/wp/v2/posts

WordPress Pages API

Standard WordPress page collection.

  • Endpoint: GET /wp-json/wp/v2/pages

Native Services CPT API

The raw, unnormalized WordPress REST endpoint for the services custom post type,
for clients that prefer working directly with WordPress’s native schema instead of
the normalized Services API above.

  • Endpoint: GET /wp-json/wp/v2/services (exact path depends on the registered REST base)

Other discovery mechanisms

  • RFC 9727 API Catalog/.well-known/api-catalog. A single machine-readable index of every endpoint on this page, plus the Request a Quote and Gift Certificates actions.
  • AI Catalog/.well-known/ai-catalog.json. Protocol-agnostic discovery document (ai-catalog.io spec) referencing the RFC 9727 catalog above.
  • llms.txt/llms.txt. Plain-language guidance for LLMs about this site.
  • Markdown negotiation — any page on this site returns a clean Markdown version when requested with Accept: text/markdown.
  • Content Signals — declared in /robots.txt (search, AI input, and AI training preferences).

Actions (non-API)