Sign in
Comments

List comments on a DIR

List the comments on a DIR. The enterprise is resolved server-side from the DIR id.

get/dir/{dir_id}/comments

Path parameters

dir_idstring uuid required
Example:16635d38-75a6-4481-82e8-69af60e05011

The DIR id. Lowercase UUID.

Query parameters

page[number]integer
Example:1

1-based page number. Out-of-range values return an empty page with correct meta.

page[size]integer
Example:20

Items per page. Maximum 250; values above are clamped to 250.

comment_type'vetting_comment' | 'rejection_reason' | 'internal_note' | 'notification' | 'status_update' | 'customer_inquiry' | 'admin_response'

Comment categorisation. Customers post customer_inquiry. The Telnyx team posts vetting_comment, rejection_reason, notification, status_update, or admin_response. internal_note is filtered out of customer-visible responses.

Restrict to comments of this category. Customer-visible categories only: internal-only comments are filtered out regardless of this filter.

Response

Paginated list of comments.

Example response

{
  "data": [
    {
      "id": "30bbd13c-1f3a-47c0-8fa6-718835917b2f",
      "entity_type": "dir",
      "content": "Please re-upload a clearer scan of the certificate.",
      "visibility": "customer",
      "author_role": "customer",
      "created_at": "2026-04-27T00:42:44.305835Z"
    }
  ],
  "meta": {
    "total_pages": 3,
    "total_results": 42,
    "page_number": 1,
    "page_size": 20
  }
}

Changes

Changed in 1 of the 47 revisions of this API.1