v1

latestOpenAPI 3.0.32026-07-24156161.2 MB
User Groups

Get group

The Get group API request retreives all the details of a specific user group. You should add the user group id as a variable in the request.

get/groups/{id}

Query parameters

fieldsstring
Example:description;ratio

Response

Successful operation / Successful operation

Example response

{
  "groups": [
    {
      "amd_enabled": "0",
      "available_agent_search_timeout": "30",
      "background_dialing_allowed": "0",
      "background_dialing_feedback_prediction_time": null,
      "background_dialing_ratio": null,
      "description": "leads from campaign: Test",
      "drop_rate_period": "10",
      "feedback_after_permanent_assignment": "0",
      "id": "1",
      "is_deleted": "0",
      "name": "TestGroup1",
      "outbound_ivr_enabled": "0",
      "permanent_ratio_dial_as_no_ratio": "0",
      "preview_direct_dial_lead_data": "1",
      "ratio": "2",
      "sorting_method": "fifo"
    }
  ]
}