Groups
Get assigned campaigns
Retrieve the campaigns assigned to a user group.
When to use. See which campaigns a group dials. Send the group id in the path.
Parameters. fields (optional): a semicolon-separated list of campaign fields to return, for example id;name. When omitted, the full set of campaign fields is returned.
Returns. { "groupCampaigns": [ ... ] }, one entry per assigned campaign, or an empty array if the group has no campaigns. Returns 404 if no group matches the id.
Example. GET /api/groups/5/campaigns
get/{sub_domain}/api/groups/{id}/campaigns
Request
- Base URLhttps://api.commpeak.com/dialer
- URLhttps://api.commpeak.com/dialer/{sub_domain}/api/groups/{id}/campaigns
- AuthAPI key in header Authorization
Path parameters
idinteger required
Group ID.
sub_domainstring required
Dialer Name (subdomain)
Query parameters
fieldsstring nullable
Semicolon-separated list of campaign fields to return, for example id;name.
Response
Successful Response
Example response
{
"groupCampaigns": [
{
"description": "Dialer Campaign",
"id": 51,
"name": "Dialer Campaign"
}
]
}Changes
No recorded changes to this operation across all 1 revision of this API.