---
title: "getGroups"
method: GET
path: "/getGroups"
tags: ["Groups"]
---

# getGroups

`GET /getGroups`

Returns the groups for a property

## Query parameters

- `propertyID` string, required
- `groupCode` string
- `groupProfileID` string
- `type` 'group' | 'company' | 'travel_agent'
- `status` 'open' | 'closed'
- `createdFrom` string, date-time
- `createdTo` string, date-time
- `pageSize` integer
- `pageNumber` integer

## Response `200`

200 Response

- GetGroupsResponse
  - `success` boolean — Success
  - `data` object[] — Data
    - `groupCode` string — Unique ID for a group
    - `name` string — The name of the group
    - `type` 'group' | 'company' | 'travel_agent' | 'wholesaler' — The type of the group
    - `status` 'open' | 'closed' — Group status
    - `created` string, date-time — Group created time
    - `sourceID` string — The third-party source ID for this group, can be empty
    - `sourceName` string — The third-party source name for this group, can be empty
    - `address1` string, nullable — Address
    - `address2` string, nullable — Address2
    - `city` string, nullable — City
    - `zip` string, nullable — Zip
    - `state` string, nullable — State
    - `countryCode` string, nullable — Country code
    - `commissionType` 'fixed' | 'percent', nullable — Commission type
    - `taxDocumentType` string, nullable — Tax document type
    - `taxIdNumber` string, nullable — Tax ID number
    - `legalName` string, nullable — Legal name
    - `contacts` object[], nullable — Group contacts
      - `id` string — Unique ID for a contact
      - `group_profile_id` string — The group profile ID this contact belongs to
      - `primary` boolean — Whether this is the primary contact
      - `anonymized` boolean — Whether the contact is anonymized
      - `first_name` string — Contact first name
      - `last_name` string — Contact last name
      - `role` string, nullable — Contact role
      - `status` 'active' — Contact status
      - `created_at` string, date-time — Contact creation time
      - `updated_at` string, date-time — Contact last update time
      - `emails` object[] — Contact email addresses
        - `type` 'personal' | 'business' — Email type
        - `value` string — Email address value
      - `phones` object[], nullable — Contact phone numbers
        - `type` 'home' | 'work' | 'cell_phone' | 'fax' — Phone type
        - `value` string — Phone number value
      - `is_billing_recipient` boolean — Whether this contact is a billing recipient
      - `tax_id_number` string, nullable — Contact tax ID number
      - `tax_document_type` string, nullable — Contact tax document type
      - `legal_name` string, nullable — Contact legal name
      - `address_1` string, nullable — Contact address line 1
      - `address_2` string, nullable — Contact address line 2
      - `city` string, nullable — Contact city
      - `state` string, nullable — Contact state
      - `country_code` string, nullable — Contact country code
      - `zip` string, nullable — Contact zip code

---

[API](https://skmtc.net/cloudbeds/apis/cloudbeds-api.md) · [All operations](https://skmtc.net/cloudbeds/apis/cloudbeds-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cloudbeds/cloudbeds-api/versions/2faa857793e8/schema)