Skip to content

cloudbeds/cloudbeds-api-python

BranchesTags
 
 

Repository files navigation

Cloudbeds PMS V1.3

Welcome to the documentation for Cloudbeds API Version v1.3! If you are looking to learn how to use the Cloudbeds API to access guest information, reservations, or similar data for your Cloudbeds customers, then you've come to the right place.

In this document you will find all the API methods we provide along with explanations for parameters and response examples.

If you have questions about different implementation steps (e.g. how to implement OAuth 2.0), please refer to our Integrations Portal.

Be sure to subscribe to the monthly Cloudbeds API announcement mailing list to receive information on new additions and improvements to the Cloudbeds API and related developer tools.

Endpoint: https://api.cloudbeds.com/api/v1.3/{method}

HTTPS: Our API requires HTTPS. We'll respond with an appropriate error if you're not using it.

Request Format: HTTP GET, POST and PUT (Content-Type: application/x-www-form-urlencoded)

Response Format: JSON

Response Header: X-Request-ID is added to response headers in all calls to help accelerate support and troubleshooting.

\"Run use this link to access our Public collection in Postman.

The cloudbeds_pms_v1_3 package is automatically generated by the OpenAPI Generator project:

  • API version: v1.3
  • Package version: 1.7.0
  • Generator version: 7.11.0
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.8+

Installation & Usage

This python library package is generated without supporting files like setup.py or requirements files

To be able to use it, you will need these dependencies in your own package that uses this library:

  • urllib3 >= 1.25.3, < 3.0.0
  • python-dateutil >= 2.8.2
  • pydantic >= 2
  • typing-extensions >= 4.7.1

Getting Started

In your own code, to use this library to connect and interact with Cloudbeds PMS V1.3, you can run the following:

import cloudbeds_pms_v1_3
from cloudbeds_pms_v1_3.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.cloudbeds.com/api/v1.3
# See configuration.py for a list of all supported configuration parameters.
configuration = cloudbeds_pms_v1_3.Configuration(
    host = "https://api.cloudbeds.com/api/v1.3"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'


# Enter a context with an instance of the API client
with cloudbeds_pms_v1_3.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cloudbeds_pms_v1_3.AdjustmentApi(api_client)
    reservation_id = 'reservation_id_example' # str | Reservation identifier
    adjustment_id = 'adjustment_id_example' # str | Adjustment identifier
    property_id = 'property_id_example' # str | Property ID (optional)

    try:
        # deleteAdjustment
        api_response = api_instance.delete_adjustment_delete(reservation_id, adjustment_id, property_id=property_id)
        print("The response of AdjustmentApi->delete_adjustment_delete:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AdjustmentApi->delete_adjustment_delete: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://api.cloudbeds.com/api/v1.3

Class Method HTTP request Description
AdjustmentApi delete_adjustment_delete DELETE /deleteAdjustment deleteAdjustment
AdjustmentApi post_adjustment_post POST /postAdjustment postAdjustment
AllotmentBlocksApi create_allotment_block_notes_post POST /createAllotmentBlockNotes createAllotmentBlockNotes
AllotmentBlocksApi create_allotment_block_post POST /createAllotmentBlock createAllotmentBlock
AllotmentBlocksApi delete_allotment_block_post POST /deleteAllotmentBlock deleteAllotmentBlock
AllotmentBlocksApi get_allotment_blocks_get GET /getAllotmentBlocks getAllotmentBlocks
AllotmentBlocksApi list_allotment_block_notes_get GET /listAllotmentBlockNotes listAllotmentBlockNotes
AllotmentBlocksApi update_allotment_block_notes_post POST /updateAllotmentBlockNotes updateAllotmentBlockNotes
AllotmentBlocksApi update_allotment_block_post POST /updateAllotmentBlock updateAllotmentBlock
AppSettingsApi delete_app_property_settings_post POST /deleteAppPropertySettings deleteAppPropertySettings
AppSettingsApi get_app_property_settings_get GET /getAppPropertySettings getAppPropertySettings
AppSettingsApi post_app_property_settings_post POST /postAppPropertySettings postAppPropertySettings
AppSettingsApi put_app_property_settings_post POST /putAppPropertySettings putAppPropertySettings
AuthenticationApi access_token_post POST /access_token access_token
AuthenticationApi oauth_metadata_get GET /oauth/metadata metadata
AuthenticationApi userinfo_get GET /userinfo userinfo
CurrencyApi get_currency_settings_get GET /getCurrencySettings getCurrencySettings
CustomFieldsApi get_custom_fields_get GET /getCustomFields getCustomFields
CustomFieldsApi post_custom_field_post POST /postCustomField postCustomField
DashboardApi get_dashboard_get GET /getDashboard getDashboard
EmailsApi get_email_schedule_get GET /getEmailSchedule getEmailSchedule
EmailsApi get_email_templates_get GET /getEmailTemplates getEmailTemplates
EmailsApi post_email_schedule_post POST /postEmailSchedule postEmailSchedule
EmailsApi post_email_template_post POST /postEmailTemplate postEmailTemplate
GroupsApi get_group_notes_get GET /getGroupNotes getGroupNotes
GroupsApi get_groups_get GET /getGroups getGroups
GroupsApi patch_group_post POST /patchGroup patchGroup
GroupsApi post_group_note_post POST /postGroupNote postGroupNote
GroupsApi put_group_post POST /putGroup putGroup
GuestApi delete_guest_note_delete DELETE /deleteGuestNote deleteGuestNote
GuestApi get_guest_get GET /getGuest getGuest
GuestApi get_guest_list_get GET /getGuestList getGuestList
GuestApi get_guest_notes_get GET /getGuestNotes getGuestNotes
GuestApi get_guests_by_filter_get GET /getGuestsByFilter getGuestsByFilter
GuestApi get_guests_by_status_get GET /getGuestsByStatus getGuestsByStatus
GuestApi get_guests_modified_get GET /getGuestsModified getGuestsModified
GuestApi post_guest_document_post POST /postGuestDocument postGuestDocument
GuestApi post_guest_note_post POST /postGuestNote postGuestNote
GuestApi post_guest_photo_post POST /postGuestPhoto postGuestPhoto
GuestApi post_guest_post POST /postGuest postGuest
GuestApi post_guests_to_room_post POST /postGuestsToRoom postGuestsToRoom
GuestApi put_guest_note_put PUT /putGuestNote putGuestNote
GuestApi put_guest_put PUT /putGuest putGuest
HotelApi get_files_get GET /getFiles getFiles
HotelApi get_hotel_details_get GET /getHotelDetails getHotelDetails
HotelApi get_hotels_get GET /getHotels getHotels
HotelApi post_file_post POST /postFile postFile
HouseAccountApi get_house_account_list_get GET /getHouseAccountList getHouseAccountList
HouseAccountApi post_new_house_account_post POST /postNewHouseAccount postNewHouseAccount
HouseAccountApi put_house_account_status_put PUT /putHouseAccountStatus putHouseAccountStatus
HousekeepingApi get_housekeepers_get GET /getHousekeepers getHousekeepers
HousekeepingApi get_housekeeping_status_get GET /getHousekeepingStatus getHousekeepingStatus
HousekeepingApi post_housekeeper_post POST /postHousekeeper postHousekeeper
HousekeepingApi post_housekeeping_assignment_post POST /postHousekeepingAssignment postHousekeepingAssignment
HousekeepingApi post_housekeeping_status_post POST /postHousekeepingStatus postHousekeepingStatus
HousekeepingApi put_housekeeper_put PUT /putHousekeeper putHousekeeper
IntegrationApi delete_webhook_delete DELETE /deleteWebhook deleteWebhook
IntegrationApi get_app_settings_get GET /getAppSettings getAppSettings
IntegrationApi get_app_state_get GET /getAppState getAppState
IntegrationApi get_webhooks_get GET /getWebhooks getWebhooks
IntegrationApi post_app_error_post POST /postAppError postAppError
IntegrationApi post_app_state_post POST /postAppState postAppState
IntegrationApi post_government_receipt_post POST /postGovernmentReceipt postGovernmentReceipt
IntegrationApi post_webhook_post POST /postWebhook postWebhook
ItemApi append_custom_item_post POST /appendCustomItem appendCustomItem
ItemApi get_item_categories_get GET /getItemCategories getItemCategories
ItemApi get_item_get GET /getItem getItem
ItemApi get_items_get GET /getItems getItems
ItemApi post_custom_item_post POST /postCustomItem postCustomItem
ItemApi post_item_category_post POST /postItemCategory postItemCategory
ItemApi post_item_post POST /postItem postItem
ItemApi post_items_to_inventory_post POST /postItemsToInventory postItemsToInventory
ItemApi post_void_item_post POST /postVoidItem postVoidItem
ItemApi put_item_to_inventory_put PUT /putItemToInventory putItemToInventory
PackageApi get_package_names_get GET /getPackageNames getPackageNames
PackageApi get_packages_get GET /getPackages getPackages
PaymentApi get_payment_methods_get GET /getPaymentMethods getPaymentMethods
PaymentApi get_payments_capabilities_get GET /getPaymentsCapabilities getPaymentsCapabilities
PaymentApi post_charge_post POST /postCharge postCharge
PaymentApi post_credit_card_post POST /postCreditCard postCreditCard
PaymentApi post_custom_payment_method_post POST /postCustomPaymentMethod postCustomPaymentMethod
PaymentApi post_payment_post POST /postPayment postPayment
PaymentApi post_void_payment_post POST /postVoidPayment postVoidPayment
RateApi get_rate_get GET /getRate getRate
RateApi get_rate_jobs_get GET /getRateJobs getRateJobs
RateApi get_rate_plans_get GET /getRatePlans getRatePlans
RateApi patch_rate_post POST /patchRate patchRate
RateApi put_rate_post POST /putRate putRate
ReservationApi delete_reservation_note_delete DELETE /deleteReservationNote deleteReservationNote
ReservationApi get_reservation_assignments_get GET /getReservationAssignments getReservationAssignments
ReservationApi get_reservation_get GET /getReservation getReservation
ReservationApi get_reservation_notes_get GET /getReservationNotes getReservationNotes
ReservationApi get_reservations_get GET /getReservations getReservations
ReservationApi get_reservations_with_rate_details_get GET /getReservationsWithRateDetails getReservationsWithRateDetails
ReservationApi get_sources_get GET /getSources getSources
ReservationApi post_reservation_document_post POST /postReservationDocument postReservationDocument
ReservationApi post_reservation_note_post POST /postReservationNote postReservationNote
ReservationApi post_reservation_post POST /postReservation postReservation
ReservationApi put_reservation_note_put PUT /putReservationNote putReservationNote
ReservationApi put_reservation_put PUT /putReservation putReservation
RoomApi delete_room_block_delete DELETE /deleteRoomBlock deleteRoomBlock
RoomApi get_available_room_types_get GET /getAvailableRoomTypes getAvailableRoomTypes
RoomApi get_reservation_room_details_get GET /getReservationRoomDetails getReservationRoomDetails
RoomApi get_room_blocks_get GET /getRoomBlocks getRoomBlocks
RoomApi get_room_types_get GET /getRoomTypes getRoomTypes
RoomApi get_rooms_fees_and_taxes_get GET /getRoomsFeesAndTaxes getRoomsFeesAndTaxes
RoomApi get_rooms_get GET /getRooms getRooms
RoomApi get_rooms_unassigned_get GET /getRoomsUnassigned getRoomsUnassigned
RoomApi post_room_assign_post POST /postRoomAssign postRoomAssign
RoomApi post_room_block_post POST /postRoomBlock postRoomBlock
RoomApi post_room_check_in_post POST /postRoomCheckIn postRoomCheckIn
RoomApi post_room_check_out_post POST /postRoomCheckOut postRoomCheckOut
RoomApi put_room_block_put PUT /putRoomBlock putRoomBlock
TaxesAndFeesApi get_taxes_and_fees_get GET /getTaxesAndFees getTaxesAndFees
UserApi get_users_get GET /getUsers getUsers

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

api_key

  • Type: API key
  • API key parameter name: x-api-key
  • Location: HTTP header

OAuth2

  • Type: OAuth
  • Flow: accessCode
  • Authorization URL:
  • Scopes:
  • delete:adjustment: delete:adjustment
  • delete:appPropertySettings: delete:appPropertySettings
  • delete:roomblock: delete:roomblock
  • read:allotmentBlock: read:allotmentBlock
  • read:appPropertySettings: read:appPropertySettings
  • read:communication: read:communication
  • read:currency: read:currency
  • read:customFields: read:customFields
  • read:dashboard: read:dashboard
  • read:group: read:group
  • read:guest: read:guest
  • read:hotel: read:hotel
  • read:houseAccount: read:houseAccount
  • read:housekeeping: read:housekeeping
  • read:item: read:item
  • read:package: read:package
  • read:payment: read:payment
  • read:rate: read:rate
  • read:reservation: read:reservation
  • read:room: read:room
  • read:roomblock: read:roomblock
  • read:taxesAndFees: read:taxesAndFees
  • read:user: read:user
  • write:adjustment: write:adjustment
  • write:allotmentBlock: write:allotmentBlock
  • write:appError: write:appError
  • write:appPropertySettings: write:appPropertySettings
  • write:communication: write:communication
  • write:customFields: write:customFields
  • write:group: write:group
  • write:guest: write:guest
  • write:hotel: write:hotel
  • write:houseAccount: write:houseAccount
  • write:housekeeping: write:housekeeping
  • write:item: write:item
  • write:payment: write:payment
  • write:rate: write:rate
  • write:reservation: write:reservation
  • write:room: write:room
  • write:roomblock: write:roomblock

Author

About

Cloudbeds Python API (managed by Terraform)

Topics

code managed-by-terraform

Resources

Readme

License

MIT license
Activity
Custom properties

Stars

2 stars

Watchers

2 watching

Forks

0 forks
Report repository

Releases 9

2.7.0 Latest
Oct 30, 2025
+ 8 releases

Packages

No packages published

Contributors 3

  •  
  •  
  •  

Languages