Back to DevelopersOpenAPI 3.1.0

NestBuddy OpenAPI 3.1 Specification Explorer

Interactive human-friendly viewer for NestBuddy's OpenAPI contract. For automated tooling and AI agents, the raw schema is published at /openapi.json.

NestBuddy Public Discovery & Intake API

OpenAPI Version 3.1.0 • Specification Format: JSON

Server: https://nestbuddy.com.au

API Paths & Operations

Returns supported moving trade categories (removalist, bond_clean, storage, gardener, conveyancer), location requirements, brand context, and conversational chunking guidelines.

operationId: discoverQuoteServices

Responses

200 OKService registry metadata, supported trade schemas, and brand guidelines.

Accepts a multi-trade moving payload, validates location/property constraints, creates a pending quote, and dispatches a 1-tap email verification magic link. Supports ?dry_run=true for sandbox testing.

operationId: submitQuoteRequest

Query Parameters

dry_run(boolean)When true, validates payload without creating DB records or sending emails.

Request Body Schema (application/json)

{
  "services": ["removalist", "bond_clean"],
  "locations": {
    "from": "Wynnum QLD 4178",
    "to": "Manly QLD 4179"
  },
  "timing": {
    "date": "2026-11-19",
    "date_mode": "on"
  },
  "home": {
    "bedrooms": "3",
    "bathrooms": "2",
    "property_type": "house"
  },
  "contact": {
    "name": "Jane Doe",
    "email": "jane@example.com",
    "phone": "0400123456",
    "preference": "email"
  }
}

Responses

202 AcceptedQuote accepted, 1-tap verification email dispatched to customer.
200 OK (dry_run)Diagnostic sandbox validation passed with diagnostic guidance.
400 Bad RequestMissing required fields or invalid trade values (includes error hints).
429 Too Many RequestsRate limit exceeded (returns standard Retry-After header).