API
DOCS

Wash Party exposes a REST API over HTTPS. All requests and responses use JSON. The base URL for all endpoints is:

https://washparty.net/api

The Wash Party API uses session-based auth for the admin panel and Bearer token auth for programmatic access. Include your API key in the Authorization header:

Authorization: Bearer wp_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

API keys are prefixed with wp_live_ (production) or wp_test_ (sandbox). Keep your key secret — it grants full operator access.

A Party represents a group booking event for a specific street. Parties move through a lifecycle: pending → active → confirmed → completed (or cancelled).

Party Object

{
  "id":                    "clxxx...",
  "code":                  "OAK4287",
  "street":                "Oak Glen Drive",
  "city":                  "Collierville",
  "zip":                   "38017",
  "status":                "active",          // pending | active | confirmed | completed | cancelled
  "serviceDate":           "2026-06-15T00:00:00.000Z",
  "deadlineAt":            "2026-06-08T00:00:00.000Z",
  "depositRequired":       true,
  "depositCents":          2500,
  "captainMessage":        "Let's get the whole block clean!",
  "participants":          [ /* ParticipantObject[] */ ]
}

Each participant is a homeowner who has reserved a spot on a party. Their status tracks the payment lifecycle.

Participant Object

{
  "id":                "clyyy...",
  "firstName":         "Jane",
  "lastName":          "D",
  "houseNumber":       "104",
  "joinIndex":         3,
  "status":            "confirmed",  // pending_payment | confirmed | cancelled | refunded
  "earlyBirdEligible": true,
  "referralCode":      "JAN8821"
}

Pricing / Quote

When joining, the API returns a quote showing group discount, early-bird bonus, and amount due:

// POST /api/party/:code/join response
{
  "data": {
    "checkoutUrl":  "https://checkout.stripe.com/...",   // if deposit required
    "successUrl":   "/party/OAK4287?success=1&pid=...",  // if no deposit
    "quote": {
      "subtotal":           52500,
      "tierDiscount":       7875,
      "earlyBirdDiscount":  2625,
      "discountedSubtotal": 42000,
      "depositCents":       2500,
      "dueAtServiceCents":  39500
    }
  }
}

Find active parties near an address using the search endpoint.

// GET /api/party/search?street=Oak&zip=38017
{
  "data": [
    {
      "code":              "OAK4287",
      "street":            "Oak Glen Drive",
      "city":              "Collierville",
      "zip":               "38017",
      "status":            "active",
      "participant_count": 4
    }
  ]
}

Admin endpoints require an active operator session (cookie) or an admin-scoped API key. These power the Operator Dashboard.

Wash Party fires webhooks for key lifecycle events. Configure your endpoint URL in the operator dashboard under Settings → Integrations.

Webhook Payload

POST https://your-endpoint.com/webhooks/washparty
Content-Type: application/json
X-WashParty-Signature: sha256=<hmac>

{
  "event":     "participant.joined",
  "timestamp": "2026-06-01T14:22:00.000Z",
  "data": {
    "partyCode":       "OAK4287",
    "participantId":   "clyyy...",
    "depositCents":    2500,
    "servicesChosen":  ["house", "driveway"]
  }
}

All error responses return a consistent JSON shape with a machine-readable code:

{
  "error": {
    "code":    "PARTY_DEADLINE_PASSED",
    "message": "The sign-up deadline for this party has passed.",
    "details": {}
  },
  "requestId": "941cf436-9dcd-..."
}

Public endpoints (party lookup, search, join) are rate-limited to 60 requests / minute per IP. Admin API endpoints are limited to 300 requests / minute per key. Rate limit headers are included in every response:

X-RateLimit-Limit: 60
X-RateLimit-Remaining: 47
X-RateLimit-Reset: 1717257600

Webhook delivery is retried up to 5 times with exponential backoff (2s, 4s, 8s, 16s, 32s). Endpoints must return 2xx within 10 seconds to be considered successful.