{"openapi":"3.1.0","info":{"title":"Buildium Inventory (BYOK) API","version":"0.1.0","description":"Buildium Inventory (BYOK) lets an AI assistant read your own Buildium Inventory data through the Buildium Inventory API with a key you supply (API key client ID). Read-only: 5 tools (list_rental_appliances, list_inventory_assets, list_inventory_storages, list_property_groups, list_unit_listings). The BYOK key travels with each request, is used for that one call only and is never stored, logged or...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-buildium-inventory-listings.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-buildium-inventory-listings/docs"},"termsOfService":"https://connectorbay.com/byok-buildium-inventory-listings/terms"},"servers":[{"url":"https://byok-buildium-inventory-listings.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-buildium-inventory-listings/docs"},"security":[{"upstreamKey":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Optional. A Pro API key raises rate limits; no credentials are required."},"upstreamKey":{"type":"apiKey","in":"header","name":"X-Upstream-Key","description":"Your own key for the service this connector wraps (bring your own key). Used for that one call only; never stored, logged or cached."}},"schemas":{"Error":{"type":"object","properties":{"ok":{"const":false},"error":{"type":"object"}}}}},"paths":{"/v1/tools/list_rental_appliances":{"post":{"operationId":"list_rental_appliances","summary":"List appliances of rental properties or units with name, make, model and warranty end date. Use for \"Which appliances in","description":"List appliances of rental properties or units with name, make, model and warranty end date. Use for \"Which appliances in Buildium rental property 12345 are out of warranty\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"property_id":{"anyOf":[{"minimum":1,"type":"integer"},{"type":"null"}],"default":null,"description":"Only appliances of this rental property id.","title":"Property Id"},"unit_id":{"anyOf":[{"minimum":1,"type":"integer"},{"type":"null"}],"default":null,"description":"Only appliances of this rental unit id.","title":"Unit Id"},"limit":{"anyOf":[{"maximum":1000,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"How many records to return (1 to 1000; the provider default is 50).","title":"Limit"},"offset":{"anyOf":[{"maximum":1000000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Zero-based position of the first record to return, for paging.","title":"Offset"}},"title":"list_rental_appliancesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_inventory_assets":{"post":{"operationId":"list_inventory_assets","summary":"List inventory assets and tracked items with category, make, model, status, serial number, storage, quantity and warrant","description":"List inventory assets and tracked items with category, make, model, status, serial number, storage, quantity and warranty end date. Use for \"Which inventory items are low or out of service in Buildium\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"entity_type":{"anyOf":[{"enum":["Unknown","Association","Rental","Company"],"type":"string"},{"type":"null"}],"default":null,"description":"Owner of the item: Association, Rental or Company.","title":"Entity Type"},"entity_id":{"anyOf":[{"minimum":1,"type":"integer"},{"type":"null"}],"default":null,"description":"Only items of this entity id.","title":"Entity Id"},"storage_id":{"anyOf":[{"minimum":1,"type":"integer"},{"type":"null"}],"default":null,"description":"Only items stored in this inventory storage id.","title":"Storage Id"},"limit":{"anyOf":[{"maximum":1000,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"How many records to return (1 to 1000; the provider default is 50).","title":"Limit"},"offset":{"anyOf":[{"maximum":1000000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Zero-based position of the first record to return, for paging.","title":"Offset"}},"title":"list_inventory_assetsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_inventory_storages":{"post":{"operationId":"list_inventory_storages","summary":"List inventory storage locations (for example warehouses or trucks) with id and name. Use for \"Where do I store inventor","description":"List inventory storage locations (for example warehouses or trucks) with id and name. Use for \"Where do I store inventory in Buildium\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"entity_type":{"anyOf":[{"enum":["Unknown","Association","Rental","Company"],"type":"string"},{"type":"null"}],"default":null,"description":"Owner of the storage: Association, Rental or Company.","title":"Entity Type"},"entity_id":{"anyOf":[{"minimum":1,"type":"integer"},{"type":"null"}],"default":null,"description":"Only storages of this entity id.","title":"Entity Id"},"limit":{"anyOf":[{"maximum":1000,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"How many records to return (1 to 1000; the provider default is 50).","title":"Limit"},"offset":{"anyOf":[{"maximum":1000000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Zero-based position of the first record to return, for paging.","title":"Offset"}},"title":"list_inventory_storagesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_property_groups":{"post":{"operationId":"list_property_groups","summary":"List property groups with name, description and the rentals and associations in each. Use for \"Which property groups are","description":"List property groups with name, description and the rentals and associations in each. Use for \"Which property groups are set up in Buildium\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"property_id":{"anyOf":[{"minimum":1,"type":"integer"},{"type":"null"}],"default":null,"description":"Only groups containing this rental or association id.","title":"Property Id"},"text":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Part of the group name or description.","title":"Text"},"limit":{"anyOf":[{"maximum":1000,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"How many records to return (1 to 1000; the provider default is 50).","title":"Limit"},"offset":{"anyOf":[{"maximum":1000000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Zero-based position of the first record to return, for paging.","title":"Offset"}},"title":"list_property_groupsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_unit_listings":{"post":{"operationId":"list_unit_listings","summary":"List rental unit listings with rent, deposit, listing and available dates, lease terms, property name and unit number (n","description":"List rental unit listings with rent, deposit, listing and available dates, lease terms, property name and unit number (no contact details). Use for \"Which Buildium units are currently listed for rent\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"entity_type":{"anyOf":[{"enum":["Property","RentalOwner"],"type":"string"},{"type":"null"}],"default":null,"description":"What entity_id refers to: Property or RentalOwner.","title":"Entity Type"},"entity_id":{"anyOf":[{"minimum":1,"type":"integer"},{"type":"null"}],"default":null,"description":"Only listings of this entity id.","title":"Entity Id"},"limit":{"anyOf":[{"maximum":1000,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"How many records to return (1 to 1000; the provider default is 50).","title":"Limit"},"offset":{"anyOf":[{"maximum":1000000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Zero-based position of the first record to return, for paging.","title":"Offset"}},"title":"list_unit_listingsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}}}}