Jump to Content

Home Guides and Articles Recipes API Reference GraphQL Changelog

API Reference

Home Guides and Articles Recipes API Reference GraphQL Changelog

All

Pages

Start typing to search…

Cloudbeds API Overview

Introduction
Tech Specs
Webhooks

Cloudbeds API

Authentication
Adjustment
- deleteAdjustmentdel
- postAdjustmentpost
AllotmentBlocks
AppSettings
Currency
- getCurrencySettingsget
CustomFields
- getCustomFieldsget
- postCustomFieldpost
Dashboard
- getDashboardget
Emails
Groups
Guest
Hotel
HouseAccount
Housekeeping
Integration
Item
Package
- getPackagesget
- getPackageNamesget
Payment
Rate
Reservation
Room
Taxes and Fees
- getTaxesAndFeesget
User
- getUsersget

Cloudbeds API v2

Applications
- Get all connected API clients for a propertyget
Items
- Get a list of custom items for a specific property.get
- Post one or more items to a reservation, house account, or group profilepost
Market Segmentation
Rate Plans
Door Locks
Housekeeping
- Housekeeping inspection listget
Integration Events
Rooms
- Room out of servicepost
Property
- Retrieves the property's system component versionsget
Reservations
- Update room assignment for a reservationpatch
Addons
- Retrieve property add-onsget
Events

Insights API

Chart
- Get all chartsget
- Search for a chartget
Datasets
Folders
Health
- Get the health of the serviceget
Hub
Me
Reports
Property
Schedules
Search
- Search cross different resourcesget
Stock reports
Tags
Favorites
Liveness
- Get the liveness probe of the serviceget
Explore
- /datainsights/v1.1/exploreget
Task

Accounting API

Settings
- /accounting/v1.0/settingsget
- /accounting/v1.0/settingspatch
Deposits
Accounts Receivable Ledger
Custom General Ledger Codes
- /accounting/v1.0/custom-general-ledger-codesget
- /accounting/v1.0/custom-general-ledger-codesput
Custom Transaction Codes
Transactions
- /accounting/v1.0/transactionspost
- /accounting/v1.0/pending-transactionspost
Trial balance
Internal transaction codes
- /accounting/v1.0/internal-transaction-codesget
SourceBalance
- /accounting/v1.0/source-balances/{sourceKind}/{sourceId}get

Pay by Link

Pay By Link
- Create a Pay By Linkpost
- Retrieve a Pay By Linkget

Fiscal document service API

Fiscal Documents
Configs
Features
- Get enabled features for the current user and propertyget
Export
- Get folio list of transactions exported as PDFpost

Group Profile API

Profile
ProfilePerson
ContactPerson
ProfileNote
ProfileTag
ProfileDocument

Powered by

Get contact person by ID

get

http://localhost:8700/group-profile/v1/contact-persons/{contactPersonId}

Language

Credentials

Bearer

JWT

URL

Click Try It! to start a request and see the response here!