GET - Group Hunt Groups

Returns a list of all the Hunt Groups within the specified Group.

Parameters

  • service_provider_id (str): Target Service Provider ID

  • group_id (str): Target Group ID

Returns

  • List: Returns a list of every Hunt Group within a Group, alongside their extension and name.

How To Use:

my_api.hunt_groups.get_group_hunt_groups(
    service_provider_id="serviceProviderID",
    group_id="groupID"
)

Example Returned Data (Formatted)

[
  {
    "serviceUserId": "[email protected]",
    "name": "[email protected]",
    "phoneNumber": "123456789",
    "extension": "6000",
    "department": null,
    "isActive": true,
    "policy": "Regular",
    "serviceProviderId": "serviceProviderID",
    "groupId": "groupID"
  },
  {
    "serviceUserId": "[email protected]",
    "name": "[email protected]",
    "phoneNumber": "987654321",
    "extension": "101",
    "department": null,
    "isActive": true,
    "policy": "Circular",
    "serviceProviderId": "serviceProviderID",
    "groupId": "groupID"
  }
]

Last updated

Was this helpful?