AllotmentBlocks

listAllotmentBlockNotes

List notes added to an allotment block

get/listAllotmentBlockNotes

Request

  • Base URL
    https://api.cloudbeds.com/api/v1.3
  • URL
    https://api.cloudbeds.com/api/v1.3/listAllotmentBlockNotes
  • Auth
    • API key in header x-api-key
    • or OAuth 2
      Authorization code
      Scopes: read:allotmentBlock

Query parameters

propertyIDstring required

Property ID

allotmentBlockCodestring required

Allotment block code

status'all' | 'active' | 'archived'

Note status

pageNumberinteger

Page

pageSizeinteger

Number of Items per Page (min 1, max 100)

Response

200 Response

successboolean

Returns if the request could be completed

pageSizeinteger

Number of Notes per Page

pageNumberinteger

Current page

totalinteger

Total number of Notes

Changes

No recorded changes to this operation across all 2 revisions of this API.