CLcloudbeds
Profile

Get profile by ID (any type)

Retrieve a company, group, or travel agent profile by its ID. The profile type is determined from the stored data.

get/group-profile/v1/profiles/{profileId}

Request

  • Base URL
    https://api.cloudbeds.com
  • URL
    https://api.cloudbeds.com/group-profile/v1/profiles/{profileId}
  • Auth
    HTTP bearer

Path parameters

profileIdinteger required

Entity ID

Headers

x-property-idinteger

Property ID

x-organization-idinteger required

Organization ID

Response

Profile retrieved successfully

idstring

Unique identifier for the profile

profileType'COMPANY' | 'GROUP' | 'TRAVEL_AGENT'

Profile type

codestring required

Profile code (company code, group code, or IATA number for travel agents)

namestring required

Profile name (company name, group name, or agency name)

status'PENDING' | 'ACTIVE' | 'INACTIVE' | 'CANCELLED' | 'ARCHIVED' required

Profile status

cellPhonestring

Cell phone number

phonestring

Primary phone number

emailstring email

Primary email address

externalCrmIdstring

External CRM system reference ID

optInboolean

Opt-in status

optInType'MARKETING' | 'TRANSACTIONAL'

Type of opt-in

optInMethods'EMAIL' | 'SMS' | 'NOTIFICATION'

Opt-in communication method

useBillingAsMainAddressboolean

When true, use billing address as the main address instead of the address field

createdAtstring date-time

Creation timestamp

updatedAtstring date-time

Last update timestamp

Example response

{
  "id": "19074818619469856",
  "status": "ACTIVE",
  "billingDetails": {
    "billingCurrency": "USD",
    "paymentMethod": "CREDIT_CARD",
    "billingFrequency": "MONTHLY"
  },
  "attributes": {
    "companyProfile": {
      "companyType": "CORPORATE"
    },
    "travelAgentProfile": {
      "agencyType": "RETAIL"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.