API Documentation - Employee Group

Table of Contents

Single Employee Group

GET /api/v2/group/<group_id>

Returns a single employee group specified by group_id.

Required URI Parameters

• group_id
  • Integer. Required. Must be the id of the group you are requesting the configuration for.

Single Employee Group: GET response success example payload

You will receive a 200 success response with data similar to the following.

{
    "id": 23,
    "name": "Some Employee group",
    "guided_tours_enabled": true,
    "guided_tours_external_bookings_enabled": true,
    "self_guided_tours_enabled": true,
    "self_guided_tours_external_bookings_enabled": true,
    "video_tours_enabled": true,
    "video_tours_external_bookings_enabled": true,
    "platform_of_choice": "Skype, Facebook, Hangouts"
}

Single Employee Group: GET response payload glossary

• id
  • Integer. The employee group’s unique ID.
• name
  • String. The employee group’s name.
• guided_tours_enabled
  • Boolean. Whether the employee group allows any guided tours, either booked through the API or internally within the Funnel application.
    
• guided_tours_external_bookings_enabled
  • Boolean. Whether the employee group allows guided tours booked through the API.
    Important: guided tours can only be booked if this and guided_tours_enabled are both true (tour_type=”guided”).
• self_guided_tours_enabled
  • Boolean. Whether the employee group allows any self-guided tours, either booked through the API or internally within the Funnel application
    
• self_guided_tours_external_bookings_enabled
  • Boolean. Whether the employee group allows self-guided tours booked through the API.
    Important: self guided tours can only be booked if this and self_guided_tours_enabled are both true (tour_type=”self-guided”).
• video_tours_enabled
  • Boolean. Whether the employee group allows any video tours, either booked through the API or internally within the Funnel application.
    
• video_tours_external_bookings_enabled
  • Boolean. Whether the employee group allows video tours booked through the API.
    Important: video tours can only be booked if this and video_tours_enabled are both true (is_video_tour=true & tour_type=”guided”).
• platform_of_choice:
  • String. The employee group’s supported platform of choices for the video tours.