{"openapi":"3.1.0","info":{"title":"Uplisting (BYOK) API","version":"0.1.0","description":"Uplisting (BYOK) lets an AI assistant read your own Uplisting data through the Uplisting API with a key you supply (Uplisting API key, Base64 encoded (Uplisting expects the Base64 form of the key)). Read-only: 7 tools (whoami, list_properties, get_property, search_availability, list_bookings, get_calendar, list_webhooks). The BYOK key travels with each request, is used for that one call only and...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-uplisting.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-uplisting/docs"},"termsOfService":"https://connectorbay.com/byok-uplisting/terms"},"servers":[{"url":"https://byok-uplisting.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-uplisting/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/whoami":{"post":{"operationId":"whoami","summary":"Check the API key and get the name and unique id of the Uplisting account it belongs to. Use for \"Is my Uplisting API ke","description":"Check the API key and get the name and unique id of the Uplisting account it belongs to. Use for \"Is my Uplisting API key working\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"whoamiArguments","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_properties":{"post":{"operationId":"list_properties","summary":"List all properties of the Uplisting account with name, type, capacity, bedrooms, currency, time zone and check-in and c","description":"List all properties of the Uplisting account with name, type, capacity, bedrooms, currency, time zone and check-in and check-out hours. Use for \"Which properties do I have in Uplisting\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_propertiesArguments","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/get_property":{"post":{"operationId":"get_property","summary":"Get one property with name, type, capacity, bedrooms, beds, bathrooms, currency, time zone and check-in and check-out ho","description":"Get one property with name, type, capacity, bedrooms, beds, bathrooms, currency, time zone and check-in and check-out hours. Use for \"Show Uplisting property 11033\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"property_id":{"description":"Numeric id of the property (the id field from list_properties).","maxLength":200,"title":"Property Id","type":"string"}},"required":["property_id"],"title":"get_propertyArguments","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/search_availability":{"post":{"operationId":"search_availability","summary":"Find the properties that are available for a stay, optionally by number of guests, price range and city. Use for \"Which ","description":"Find the properties that are available for a stay, optionally by number of guests, price range and city. Use for \"Which Uplisting properties are free from 2027-07-30 to 2027-08-04 for 2 guests\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"check_in":{"anyOf":[{"maxLength":10,"type":"string"},{"type":"null"}],"default":null,"description":"Check-in date, as YYYY-MM-DD.","title":"Check In"},"check_out":{"anyOf":[{"maxLength":10,"type":"string"},{"type":"null"}],"default":null,"description":"Check-out date (the morning of departure), as YYYY-MM-DD.","title":"Check Out"},"number_of_guests":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":null,"description":"Number of guests.","title":"Number Of Guests"},"max_price":{"anyOf":[{"maximum":10000000,"minimum":0,"type":"integer"},{"type":"null"}],"default":null,"description":"Highest total price allowed.","title":"Max Price"},"min_price":{"anyOf":[{"maximum":10000000,"minimum":0,"type":"integer"},{"type":"null"}],"default":null,"description":"Lowest total price expected.","title":"Min Price"},"city":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only properties in this city.","title":"City"}},"title":"search_availabilityArguments","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_bookings":{"post":{"operationId":"list_bookings","summary":"List the bookings of a property, including cancelled ones, with dates, guest name, status, channel, number of guests and","description":"List the bookings of a property, including cancelled ones, with dates, guest name, status, channel, number of guests and money amounts. Up to 50 per page; without dates it covers one year from today. Use for \"What bookings does Uplisting property 11033 have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"listing_id":{"description":"Numeric id of the property (the id field from list_properties).","maxLength":200,"title":"Listing Id","type":"string"},"from_date":{"anyOf":[{"maxLength":10,"type":"string"},{"type":"null"}],"default":null,"description":"First date, as YYYY-MM-DD.","title":"From Date"},"to_date":{"anyOf":[{"maxLength":10,"type":"string"},{"type":"null"}],"default":null,"description":"Last date, as YYYY-MM-DD.","title":"To Date"},"page":{"anyOf":[{"maximum":10000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Zero-based page number.","title":"Page"},"per_page":{"anyOf":[{"maximum":50,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"How many bookings per page (1 to 50).","title":"Per Page"}},"required":["listing_id"],"title":"list_bookingsArguments","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/get_calendar":{"post":{"operationId":"get_calendar","summary":"Get the day-by-day calendar of a property: availability, day rate, minimum stay and arrival and departure restrictions. ","description":"Get the day-by-day calendar of a property: availability, day rate, minimum stay and arrival and departure restrictions. Covers at most 12 months; without dates it is one year from today. Use for \"What are the prices and availability of Uplisting property 11033 next month\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"listing_id":{"description":"Numeric id of the property (the id field from list_properties).","maxLength":200,"title":"Listing Id","type":"string"},"from_date":{"anyOf":[{"maxLength":10,"type":"string"},{"type":"null"}],"default":null,"description":"First date, as YYYY-MM-DD.","title":"From Date"},"to_date":{"anyOf":[{"maxLength":10,"type":"string"},{"type":"null"}],"default":null,"description":"Last date, as YYYY-MM-DD.","title":"To Date"}},"required":["listing_id"],"title":"get_calendarArguments","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_webhooks":{"post":{"operationId":"list_webhooks","summary":"List the webhooks registered for the Uplisting account with event name, target URL and creation time. Use for \"Which web","description":"List the webhooks registered for the Uplisting account with event name, target URL and creation time. Use for \"Which webhooks are registered in Uplisting\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_webhooksArguments","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}}}}