Groups

Get group

Retrieve a single user group by its numeric id, with all of its settings.

When to use. Read one group's full configuration, for example before updating it or before listing its assigned users and campaigns. Returns 404 if the id does not exist.

Parameters. fields (optional): a semicolon-separated list of fields to return, for example description;ratio. When omitted, all available fields are returned.

Returns. { "groups": [ <group> ] }.

Example. GET /api/groups/5

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

Request

  • Base URL
    https://api.commpeak.com/dialer
  • URL
    https://api.commpeak.com/dialer/{sub_domain}/api/groups/{id}
  • 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 fields to return, for example description;ratio.

Response

Successful Response

Example response

{
  "groups": [
    {
      "id": 211,
      "name": "2024 Training Group"
    }
  ]
}

Changes

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