CLcloudbeds
Hotel

getFiles

Changed on

Returns a list of files attached to a hotel or group profile, ordered by creation date

get/getFiles

Request

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

Query parameters

propertyIDstring

Property ID

eventCodestring

The event (group profile) code, if the files are to be fetched from a group profile

sortBy'name' | 'type' | 'source' | 'date'

Sort By parameter

orderBy'desc' | 'asc'

Order response in DESCending or ASCending order, used together with sortBy

namestring

Filter filess by name. Include only with names containing specified string

pageNumberinteger

Results page number

pageSizeinteger

Results page size. Max = 100

Response

200 Response

successboolean

Returns if the request could be completed

countinteger

Number of results returned

totalinteger

Total number of results for supplied parameters

messagestring nullable

To be used in case any error occurs (if success = false). If success = true, it does not exist.

Changes

  • 6f4f997d5f7aRevision changes
    • warning

      deleted the query request parameter groupCode

    • info

      added the new optional query request parameter eventCode