---
title: "Get comments"
method: GET
path: "/{sub_domain}/api/comments"
tags: ["Comments"]
---

# Get comments

`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`

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](https://td.commpeak.link/Readme-dialer-api-docs). 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`

## Path parameters

- `sub_domain` string, required: Dialer Name (subdomain)

## Response `200`

Successful Response

- CommentsResponse
  - `comments` CommentItem[], required
    - `id` integer, nullable: Comment ID (present only for successfully created items).
    - `campaign_lead_id` integer, nullable: Campaign lead ID the comment belongs to.
    - `creator_user_id` integer, nullable: ID of the user who created the comment.
    - `lead_id` integer, nullable: Lead ID.
    - `body` string, nullable: The comment's text.
    - `created_at` string, nullable: Timestamp the comment was created (present only for successfully created items).
    - `username` string, nullable: Username of the comment's creator.
    - `original_identifier` string, nullable: Lead original identifier.
    - `success` boolean, nullable: true when the comment was created; otherwise a string describing why it failed.
  - `total_comments` integer, nullable: Total number of comments in the response.

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/commpeak/apis/commpeak-dialer-api.md) - [All operations](https://skmtc.dev/commpeak/apis/commpeak-dialer-api/llms.txt) - [OpenAPI document](https://skmtc.dev/commpeak/apis/commpeak-dialer-api/revisions/18c5edc07544?raw)