CLcloudbeds
Groups

getGroups

Changed on

Returns the groups for a property

get/getGroups

Request

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

Query parameters

propertyIDstring required

Property ID

eventCodestring

Unique code for an event (group)

eventProfileIDstring

GPS (Group Profile Service) external event profile ID. Returns all MFD groups linked to this GPS profile.

type'group' | 'company' | 'travel_agent'

The type of group

status'open' | 'closed'

Group status

createdFromstring date-time

Datetime (lower limit) to be queried

createdTostring date-time

Datetime (upper limit) to be queried

pageSizeinteger

Number of groups to return per page (min: 1, max: 100)

pageNumberinteger

Which page in the results to access

Response

200 Response

successboolean

Success

Changes

  • 6f4f997d5f7aRevision changes
    • warning

      deleted the query request parameter groupCode

    • warning

      deleted the query request parameter groupProfileID

    • info

      added the new optional query request parameter eventCode

    • info

      added the new optional query request parameter eventProfileID

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status