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

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required

Group ID.

string
required

Dialer Name (subdomain)

Query Params

Semicolon-separated list of fields to return, for example description;ratio.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json