Comments

Get comments

Retrieve the comments attached to your campaign leads, newest records first.

When to use. Pull the notes left on leads by your users, for review, audit, or syncing into your CRM.

Parameters. Filter, order, limit and select fields by any response field. See Core API Concepts. To return only certain fields, pass fields, for example ?fields=body;username. When no limit is given, up to 100 comments are returned.

Returns. { "comments": [ ... ], "total_comments": N }. Each comment carries its id, the campaign_lead_id and lead_id it belongs to, the creator_user_id and username of the author, the body text, and the created_at timestamp.

Example. GET /api/comments/campaign_lead_id/8/limit/50;0

get/{sub_domain}/api/comments

Request

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

Path parameters

sub_domainstring required

Dialer Name (subdomain)

Response

Successful Response

total_commentsinteger nullable

Total number of comments in the response.

Example response

{
  "comments": [
    {
      "body": "I should be the one to call back to this customer",
      "campaign_lead_id": 257456,
      "created_at": "2016-12-07 11:15:02",
      "creator_user_id": 126,
      "id": 33923,
      "lead_id": 171287,
      "original_identifier": "500040",
      "username": "demo"
    }
  ]
}

Changes

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