CLcloudbeds
ContactPerson

Get contact person by ID

get/group-profile/v1/contact-persons/{contactPersonId}

Request

  • Base URL
    https://api.cloudbeds.com
  • URL
    https://api.cloudbeds.com/group-profile/v1/contact-persons/{contactPersonId}
  • Auth
    HTTP bearer

Path parameters

contactPersonIdinteger required

Contact person ID

Headers

x-property-idinteger

Property ID

x-organization-idinteger required

Organization ID

Response

Contact person retrieved successfully

idstring

Contact person ID

isMainContactboolean

Whether this is the main contact (from profile-person relationship, only populated when profileId filter was provided)

role'BOOKING_COORDINATOR' | 'ONSITE_COORDINATOR' | 'ROOMING_LIST_CONTACT' | 'ACCOUNTS_PAYABLE' | 'BILLING' | 'INVOICING' | 'ACCOUNT_MANAGER' | 'SALES_LEAD' | 'TRAVEL_AGENT_ACCOUNT_MANAGER' | 'CORPORATE_CONTACT' | 'AUTHORIZED_SIGNER' | 'EXECUTIVE_APPROVER' | 'MARKETING' | 'MAIN_POINT_OF_CONTACT' | 'ADMINISTRATIVE' | 'OTHER'

Role of person in the profile relationship

relationshipType'EMPLOYEE' | 'BOOKED_BY' | 'PART_OF_GROUP' | 'CONTACT' | 'GUEST' | 'DECISION_MAKER' | 'TRAVELER' | 'PRIMARY' | 'SECONDARY' | 'BILLING_CONTACT' | 'EMERGENCY_CONTACT'

Type of relationship between person and profile

startDatestring date

Start date of the relationship (from profile-person relationship, only populated when profileId filter was provided)

endDatestring date

End date of the relationship (from profile-person relationship, only populated when profileId filter was provided)

anonymizedboolean

Whether the contact is anonymized

prefixstring

Name prefix (Mr., Mrs., Dr., etc.)

firstNamestring

First name

lastNamestring

Last name

statusstring

Contact person status. Allowed values are ACTIVE, DELETED

createdAtstring date-time

Creation timestamp

updatedAtstring date-time

Last update timestamp

Example response

{
  "role": "BOOKING_COORDINATOR",
  "relationshipType": "PRIMARY",
  "prefix": "Mr.",
  "firstName": "John",
  "lastName": "Doe",
  "emails": [
    {
      "emailType": "work",
      "email": "john.doe@example.com"
    }
  ],
  "phones": [
    {
      "phoneType": "mobile",
      "phone": "+1-555-123-4567"
    }
  ],
  "status": "ACTIVE",
  "billingDetails": {
    "billingCurrency": "USD",
    "paymentMethod": "CREDIT_CARD",
    "billingFrequency": "MONTHLY"
  }
}

Changes

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