{
  "openapi": "3.1.0",
  "info": {
    "title": "TIDY API",
    "version": "1.0.0",
    "description": "The TIDY API lets you manage cleaning and maintenance automation programmatically. You can request jobs, manage pros, update to-do lists, and handle guest reservations.",
    "contact": {
      "name": "TIDY API Support",
      "url": "https://tidy.com/docs/developers"
    }
  },
  "servers": [
    {
      "url": "https://api.tidy.com/v1",
      "description": "Production server"
    }
  ],
  "security": [
    {
      "ApiKeyAuth": []
    }
  ],
  "tags": [
    {
      "name": "Jobs",
      "description": "Request and manage cleaning and maintenance jobs"
    },
    {
      "name": "Addresses",
      "description": "Manage physical locations for service"
    },
    {
      "name": "Pros",
      "description": "Manage your service professionals"
    },
    {
      "name": "To-Do Lists",
      "description": "Manage job to-do lists and tasks"
    },
    {
      "name": "Reservations",
      "description": "Manage guest reservations for properties"
    }
  ],
  "paths": {
    "/jobs": {
      "get": {
        "summary": "List jobs",
        "description": "Retrieve a list of all jobs for your account",
        "tags": ["Jobs"],
        "parameters": [
          {
            "name": "address_id",
            "in": "query",
            "description": "Filter jobs by address ID",
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "status",
            "in": "query",
            "description": "Filter jobs by status",
            "schema": {
              "type": "string",
              "enum": ["pending", "confirmed", "in_progress", "completed", "cancelled"]
            }
          },
          {
            "name": "limit",
            "in": "query",
            "description": "Number of results to return (max 100)",
            "schema": {
              "type": "integer",
              "default": 20,
              "maximum": 100
            }
          },
          {
            "name": "offset",
            "in": "query",
            "description": "Offset for pagination",
            "schema": {
              "type": "integer",
              "default": 0
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "jobs": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/Job"
                      }
                    },
                    "total": {
                      "type": "integer"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/UnauthorizedError"
          }
        }
      },
      "post": {
        "summary": "Create a job",
        "description": "Request a new cleaning or maintenance job",
        "tags": ["Jobs"],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/JobCreate"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Job created successfully",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Job"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/BadRequestError"
          },
          "401": {
            "$ref": "#/components/responses/UnauthorizedError"
          }
        }
      }
    },
    "/jobs/{job_id}": {
      "get": {
        "summary": "Get job details",
        "description": "Retrieve detailed information about a specific job",
        "tags": ["Jobs"],
        "parameters": [
          {
            "name": "job_id",
            "in": "path",
            "required": true,
            "description": "The job ID",
            "schema": {
              "type": "integer"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Job"
                }
              }
            }
          },
          "404": {
            "$ref": "#/components/responses/NotFoundError"
          }
        }
      },
      "patch": {
        "summary": "Update a job",
        "description": "Update job details",
        "tags": ["Jobs"],
        "parameters": [
          {
            "name": "job_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/JobUpdate"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Job updated successfully",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Job"
                }
              }
            }
          }
        }
      },
      "delete": {
        "summary": "Cancel a job",
        "description": "Cancel a scheduled job",
        "tags": ["Jobs"],
        "parameters": [
          {
            "name": "job_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer"
            }
          }
        ],
        "responses": {
          "204": {
            "description": "Job cancelled successfully"
          }
        }
      }
    },
    "/addresses": {
      "get": {
        "summary": "List addresses",
        "description": "Retrieve all addresses associated with your account",
        "tags": ["Addresses"],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "addresses": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/Address"
                      }
                    }
                  }
                }
              }
            }
          }
        }
      },
      "post": {
        "summary": "Create an address",
        "description": "Add a new property address",
        "tags": ["Addresses"],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AddressCreate"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Address created successfully",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Address"
                }
              }
            }
          }
        }
      }
    },
    "/addresses/{address_id}/todos": {
      "get": {
        "summary": "Get to-do lists for an address",
        "description": "Retrieve all to-do lists associated with an address",
        "tags": ["To-Do Lists"],
        "parameters": [
          {
            "name": "address_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "todos": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/TodoList"
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/pros": {
      "get": {
        "summary": "List pros",
        "description": "Retrieve all pros associated with your account",
        "tags": ["Pros"],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "pros": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/Pro"
                      }
                    }
                  }
                }
              }
            }
          }
        }
      },
      "post": {
        "summary": "Add a pro",
        "description": "Add a new service professional to your account",
        "tags": ["Pros"],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ProCreate"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Pro added successfully",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Pro"
                }
              }
            }
          }
        }
      }
    },
    "/reservations": {
      "get": {
        "summary": "List reservations",
        "description": "Retrieve guest reservations",
        "tags": ["Reservations"],
        "parameters": [
          {
            "name": "address_id",
            "in": "query",
            "schema": {
              "type": "integer"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "reservations": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/Reservation"
                      }
                    }
                  }
                }
              }
            }
          }
        }
      },
      "post": {
        "summary": "Create a reservation",
        "description": "Add a new guest reservation",
        "tags": ["Reservations"],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ReservationCreate"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Reservation created successfully",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Reservation"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "securitySchemes": {
      "ApiKeyAuth": {
        "type": "apiKey",
        "in": "header",
        "name": "X-API-Key",
        "description": "API key for authentication. Get your API key from the TIDY app under Developer settings."
      }
    },
    "schemas": {
      "Job": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "description": "Unique job identifier"
          },
          "address_id": {
            "type": "integer",
            "description": "The address where the job will be performed"
          },
          "pro_id": {
            "type": "integer",
            "nullable": true,
            "description": "The pro assigned to this job"
          },
          "service_type": {
            "type": "string",
            "description": "Type of service",
            "enum": ["cleaning", "maintenance", "inspection", "restocking"]
          },
          "status": {
            "type": "string",
            "enum": ["pending", "confirmed", "in_progress", "completed", "cancelled"]
          },
          "scheduled_at": {
            "type": "string",
            "format": "date-time",
            "description": "When the job is scheduled to start"
          },
          "completed_at": {
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "price": {
            "type": "number",
            "format": "float",
            "description": "Job price in USD"
          },
          "notes": {
            "type": "string",
            "nullable": true,
            "description": "Additional notes for the pro"
          },
          "created_at": {
            "type": "string",
            "format": "date-time"
          },
          "updated_at": {
            "type": "string",
            "format": "date-time"
          }
        }
      },
      "JobCreate": {
        "type": "object",
        "required": ["address_id", "service_type", "scheduled_at"],
        "properties": {
          "address_id": {
            "type": "integer"
          },
          "pro_id": {
            "type": "integer",
            "description": "Optional: assign a specific pro"
          },
          "service_type": {
            "type": "string",
            "enum": ["cleaning", "maintenance", "inspection", "restocking"]
          },
          "scheduled_at": {
            "type": "string",
            "format": "date-time"
          },
          "price": {
            "type": "number",
            "format": "float"
          },
          "notes": {
            "type": "string"
          }
        }
      },
      "JobUpdate": {
        "type": "object",
        "properties": {
          "scheduled_at": {
            "type": "string",
            "format": "date-time"
          },
          "notes": {
            "type": "string"
          },
          "status": {
            "type": "string",
            "enum": ["pending", "confirmed", "in_progress", "completed", "cancelled"]
          }
        }
      },
      "Address": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer"
          },
          "street": {
            "type": "string"
          },
          "city": {
            "type": "string"
          },
          "state": {
            "type": "string"
          },
          "zip": {
            "type": "string"
          },
          "country": {
            "type": "string",
            "default": "US"
          },
          "nickname": {
            "type": "string",
            "nullable": true,
            "description": "Friendly name for the property"
          },
          "access_instructions": {
            "type": "string",
            "nullable": true
          },
          "bedrooms": {
            "type": "integer",
            "nullable": true
          },
          "bathrooms": {
            "type": "number",
            "format": "float",
            "nullable": true
          },
          "square_feet": {
            "type": "integer",
            "nullable": true
          }
        }
      },
      "AddressCreate": {
        "type": "object",
        "required": ["street", "city", "state", "zip"],
        "properties": {
          "street": {
            "type": "string"
          },
          "city": {
            "type": "string"
          },
          "state": {
            "type": "string"
          },
          "zip": {
            "type": "string"
          },
          "country": {
            "type": "string",
            "default": "US"
          },
          "nickname": {
            "type": "string"
          },
          "access_instructions": {
            "type": "string"
          },
          "bedrooms": {
            "type": "integer"
          },
          "bathrooms": {
            "type": "number",
            "format": "float"
          },
          "square_feet": {
            "type": "integer"
          }
        }
      },
      "Pro": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer"
          },
          "name": {
            "type": "string"
          },
          "email": {
            "type": "string",
            "format": "email"
          },
          "phone": {
            "type": "string"
          },
          "services": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "rating": {
            "type": "number",
            "format": "float",
            "minimum": 0,
            "maximum": 5
          },
          "active": {
            "type": "boolean"
          }
        }
      },
      "ProCreate": {
        "type": "object",
        "required": ["name", "email"],
        "properties": {
          "name": {
            "type": "string"
          },
          "email": {
            "type": "string",
            "format": "email"
          },
          "phone": {
            "type": "string"
          },
          "services": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      },
      "TodoList": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer"
          },
          "name": {
            "type": "string"
          },
          "items": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/TodoItem"
            }
          }
        }
      },
      "TodoItem": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer"
          },
          "description": {
            "type": "string"
          },
          "completed": {
            "type": "boolean"
          },
          "order": {
            "type": "integer"
          }
        }
      },
      "Reservation": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer"
          },
          "address_id": {
            "type": "integer"
          },
          "guest_name": {
            "type": "string"
          },
          "check_in": {
            "type": "string",
            "format": "date-time"
          },
          "check_out": {
            "type": "string",
            "format": "date-time"
          },
          "guests": {
            "type": "integer",
            "description": "Number of guests"
          },
          "confirmation_code": {
            "type": "string"
          }
        }
      },
      "ReservationCreate": {
        "type": "object",
        "required": ["address_id", "guest_name", "check_in", "check_out"],
        "properties": {
          "address_id": {
            "type": "integer"
          },
          "guest_name": {
            "type": "string"
          },
          "check_in": {
            "type": "string",
            "format": "date-time"
          },
          "check_out": {
            "type": "string",
            "format": "date-time"
          },
          "guests": {
            "type": "integer"
          },
          "confirmation_code": {
            "type": "string"
          }
        }
      },
      "Error": {
        "type": "object",
        "properties": {
          "error": {
            "type": "string"
          },
          "message": {
            "type": "string"
          },
          "code": {
            "type": "string"
          }
        }
      }
    },
    "responses": {
      "UnauthorizedError": {
        "description": "Authentication credentials missing or invalid",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/Error"
            },
            "example": {
              "error": "Unauthorized",
              "message": "Invalid or missing API key",
              "code": "INVALID_API_KEY"
            }
          }
        }
      },
      "BadRequestError": {
        "description": "Invalid request parameters",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/Error"
            },
            "example": {
              "error": "Bad Request",
              "message": "Missing required field: address_id",
              "code": "VALIDATION_ERROR"
            }
          }
        }
      },
      "NotFoundError": {
        "description": "Resource not found",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/Error"
            },
            "example": {
              "error": "Not Found",
              "message": "Job not found",
              "code": "NOT_FOUND"
            }
          }
        }
      }
    }
  }
}