Groups

Get assigned users

Retrieve the users (agents) assigned to a user group.

When to use. See which agents belong to a group. Send the group id in the path.

Parameters. fields (optional): a semicolon-separated list of user fields to return, for example id;username. When omitted, the full set of user fields is returned.

Returns. { "groupUsers": [ ... ] }, one entry per assigned user, or an empty array if the group has no users. Returns 404 if no group matches the id.

Example. GET /api/groups/5/users

get/{sub_domain}/api/groups/{id}/users

Request

  • Base URL
    https://api.commpeak.com/dialer
  • URL
    https://api.commpeak.com/dialer/{sub_domain}/api/groups/{id}/users
  • Auth
    API key in header Authorization

Path parameters

idinteger required

Group ID.

sub_domainstring required

Dialer Name (subdomain)

Query parameters

fieldsstring nullable

Semicolon-separated list of user fields to return, for example id;username.

Response

Successful Response

Example response

{
  "groupUsers": [
    {
      "email": "test@example.com",
      "first_name": "John",
      "id": 2,
      "last_name": "Doe",
      "username": "demo",
      "virtual_extension": 1001
    }
  ]
}

Changes

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