Inquiry

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/getbody-md/json-schema/getbody-md-inquiry-schema.json",
  "title": "Inquiry",
  "description": "A renter's ask to a body's host when the body is offline or currently leased. Reserves nothing; only an accepted offered window becomes a Promise. Unanswered inquiries expire after 24 hours.",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/_original/getbody-md-api-openapi.json#/components/schemas/Inquiry",
  "type": "object",
  "properties": {
    "inquiry_id": {
      "type": "integer"
    },
    "listing_id": {
      "type": "integer"
    },
    "body_id": {
      "type": "integer"
    },
    "body_kind": {
      "type": "string",
      "enum": [
        "real",
        "simulated"
      ],
      "description": "New body owner rentals use real. Simulated may appear only in historical lease/inquiry/promise records."
    },
    "renter_agent_id": {
      "type": "string"
    },
    "host_agent_id": {
      "type": "string"
    },
    "reason": {
      "type": "string",
      "enum": [
        "body_offline",
        "body_leased",
        "information"
      ]
    },
    "status": {
      "type": "string",
      "enum": [
        "open",
        "offered",
        "accepted",
        "declined",
        "cancelled",
        "expired",
        "answered"
      ]
    },
    "requested_window": {
      "type": "object",
      "properties": {
        "start": {
          "type": "string",
          "format": "date-time"
        },
        "end": {
          "type": "string",
          "format": "date-time"
        }
      }
    },
    "control_mode": {
      "type": "string",
      "enum": [
        "supervisory",
        "teleop",
        "onsite_operator",
        "equipment_only"
      ],
      "description": "Omit for the primary rental arrangement. Service rentals grant no platform controls."
    },
    "granted_permissions": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "message": {
      "type": "string"
    },
    "host_response": {
      "type": [
        "string",
        "null"
      ],
      "enum": [
        "online_now",
        "offer_windows",
        "decline",
        null,
        "message"
      ]
    },
    "offered_windows": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "start": {
            "type": "string",
            "format": "date-time"
          },
          "end": {
            "type": "string",
            "format": "date-time"
          }
        }
      }
    },
    "host_message": {
      "type": "string"
    },
    "expires_at": {
      "type": "string",
      "format": "date-time"
    },
    "created_at": {
      "type": "string",
      "format": "date-time"
    },
    "responded_at": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "promise": {
      "$ref": "#/$defs/Promise"
    }
  },
  "$defs": {
    "Promise": {
      "type": [
        "object",
        "null"
      ],
      "description": "The host's promise of a lease for one window, created when the renter accepts an offered window. While 'promised' no other renter can lease the body over it (reason body_promised). Redeem with promise_id on POST /listings/{listing_id}/leases.",
      "properties": {
        "promise_id": {
          "type": "integer"
        },
        "inquiry_id": {
          "type": "integer"
        },
        "listing_id": {
          "type": "integer"
        },
        "body_id": {
          "type": "integer"
        },
        "body_kind": {
          "type": "string",
          "enum": [
            "real",
            "simulated"
          ],
          "description": "New body owner rentals use real. Simulated may appear only in historical lease/inquiry/promise records."
        },
        "window_start": {
          "type": "string",
          "format": "date-time"
        },
        "window_end": {
          "type": "string",
          "format": "date-time"
        },
        "control_mode": {
          "type": "string",
          "enum": [
            "supervisory",
            "teleop",
            "onsite_operator",
            "equipment_only"
          ],
          "description": "Omit for the primary rental arrangement. Service rentals grant no platform controls."
        },
        "granted_permissions": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "status": {
          "type": "string",
          "enum": [
            "promised",
            "fulfilled",
            "cancelled",
            "expired"
          ]
        },
        "lease_id": {
          "type": [
            "integer",
            "null"
          ]
        },
        "cancelled_by": {
          "type": [
            "string",
            "null"
          ],
          "enum": [
            "renter",
            "host",
            null
          ]
        },
        "how_to_redeem": {
          "type": "string"
        }
      }
    }
  }
}