Campaigns

Get all campaigns

Retrieve the campaigns defined in your account.

When to use. List and audit your campaigns, or look up a campaign's id and settings before updating or cloning it. To fetch a single campaign, use GET /campaigns/{id}.

Filtering and shape. Filter, order, limit and select fields by any response field. See Core API Concepts. The response is wrapped as { "campaigns": [ ... ], "total_campaigns": N }.

Example. GET /api/campaigns/limit/50;0

get/{sub_domain}/api/campaigns

Request

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

Path parameters

sub_domainstring required

Dialer Name (subdomain)

Response

Successful Response

total_campaignsinteger nullable

Number of campaigns in the response.

Example response

{
  "campaigns": [
    {
      "description": "Dialer Campaign",
      "id": 51,
      "name": "Dialer Campaign"
    }
  ]
}

Changes

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