Dumpster Controls Leads API

openapi: 3.2.0
info:
  title: Dumpster Controls Leads API
  version: 1.0.0
  description: 'Public REST API for Dumpster Controls. Read your company''s own data and push in leads, always scoped to your company. Access is approval-gated: request a key in Settings, API. Free plan includes 10 minutes of API time per day; paid plans are unlimited. Money is in US dollars. This spec is versioned at /v1 and additive; breaking changes ship under a new version.'
  contact:
    name: Dumpster Controls
    url: https://dumpstercontrols.io/developers
servers:
- url: https://gcwyoiihrupbfqqlcurh.supabase.co/functions/v1/api-v1/v1
  description: Production
security:
- bearerAuth: []
tags:
- name: Leads
paths:
  /leads:
    get:
      summary: List leads
      operationId: listLeads
      parameters:
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/per_page'
      responses:
        '200':
          description: A page of leads.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Lead'
        '401':
          $ref: '#/components/responses/Unauthorized'
      tags:
      - Leads
    post:
      summary: Create a lead
      operationId: createLead
      description: Push a lead into Dumpster Controls (e.g. from a GoHighLevel funnel or a website form). Does not consume the daily 10-minute window; free plan allows 200 leads/day. Duplicate phone/email within 10 minutes returns the existing lead.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - name
              properties:
                name:
                  type: string
                  maxLength: 120
                phone:
                  type: string
                email:
                  type: string
                address:
                  type: string
                size_label:
                  type: string
                note:
                  type: string
      responses:
        '201':
          description: Lead created.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/Lead'
        '200':
          description: 'Duplicate: existing lead returned (existing: true).'
        '400':
          description: Invalid body or missing name.
        '401':
          $ref: '#/components/responses/Unauthorized'
        '429':
          $ref: '#/components/responses/RateLimited'
      tags:
      - Leads
components:
  schemas:
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
        upgrade_url:
          type:
          - string
          - 'null'
    Lead:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        phone:
          type:
          - string
          - 'null'
        email:
          type:
          - string
          - 'null'
        address:
          type:
          - string
          - 'null'
        size_label:
          type:
          - string
          - 'null'
        note:
          type:
          - string
          - 'null'
        status:
          type: string
          enum:
          - new
          - contacted
          - converted
          - discarded
        source:
          type: string
        created_at:
          type: string
          format: date-time
  responses:
    RateLimited:
      description: 60 requests/minute per key exceeded, or the free plan's daily 10-minute window ended.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: Missing, invalid or revoked API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  parameters:
    per_page:
      name: per_page
      in: query
      schema:
        type: integer
        default: 25
        minimum: 1
        maximum: 100
    page:
      name: page
      in: query
      schema:
        type: integer
        default: 1
        minimum: 1
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Send your API key as a Bearer token: Authorization: Bearer dc_live_... Keys are approved in Settings, API and must be kept secret (server-side only).'
x-webhooks:
  description: 'Configure signed webhooks in Settings, API. We POST events to your URL with header X-DC-Signature: t=<unix>,v1=<hex>, where v1 is HMAC-SHA256 of ''<t>.<raw body>'' using your endpoint secret. Verify it with a 5-minute timestamp tolerance. Events: order.created, order.status_changed, payment.received, lead.created, junk_job.created, junk_job.status_changed. Delivery retries with backoff up to 5 attempts.'