List comments on a DIR

GET

dir

{dir_id}

comments

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const commentListResponse of client.dir.comments.list(
  '16635d38-75a6-4481-82e8-69af60e05011',
)) {
  console.log(commentListResponse.id);
}

import os
from telnyx import Telnyx

client = Telnyx(
    api_key=os.environ.get("TELNYX_API_KEY"),  # This is the default and can be omitted
)
page = client.dir.comments.list(
    dir_id="16635d38-75a6-4481-82e8-69af60e05011",
)
page = page.data[0]
print(page.id)

package main

import (
	"context"
	"fmt"

	"github.com/team-telnyx/telnyx-go"
	"github.com/team-telnyx/telnyx-go/option"
)

func main() {
	client := telnyx.NewClient(
		option.WithAPIKey("My API Key"),
	)
	page, err := client.Dir.Comments.List(
		context.TODO(),
		"16635d38-75a6-4481-82e8-69af60e05011",
		telnyx.DirCommentListParams{},
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", page)
}

package com.telnyx.sdk.example;

import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
import com.telnyx.sdk.models.dir.comments.CommentListPage;
import com.telnyx.sdk.models.dir.comments.CommentListParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        TelnyxClient client = TelnyxOkHttpClient.fromEnv();

        CommentListPage page = client.dir().comments().list("16635d38-75a6-4481-82e8-69af60e05011");
    }
}

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Telnyx\Client;
use Telnyx\Core\Exceptions\APIException;

$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');

try {
  $page = $client->dir->comments->list(
    '16635d38-75a6-4481-82e8-69af60e05011',
    commentType: 'vetting_comment',
    pageNumber: 1,
    pageSize: 20,
  );

  var_dump($page);
} catch (APIException $e) {
  echo $e->getMessage();
}

{
  "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",
      "author_name": null,
      "comment_type": "vetting_comment",
      "created_at": "2026-04-27T00:42:44.305835Z"
    }
  ],
  "meta": {
    "total_pages": 3,
    "total_results": 42,
    "page_number": 1,
    "page_size": 20
  }
}

Authorizations

Authorization

string

header

required

Telnyx API key. Generate one at https://portal.telnyx.com/#/app/api-keys.

Path Parameters

dir_id

string<uuid>

required

The DIR id. Lowercase UUID.

Example:

"16635d38-75a6-4481-82e8-69af60e05011"

Query Parameters

page[number]

integer

default:1

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

Required range: x >= 1

Example:

1

page[size]

integer

default:20

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

Required range: 1 <= x <= 250

Example:

20

comment_type

enum<string>

Restrict to comments of this category. Customer-visible categories only: internal-only comments are filtered out regardless of this filter. 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.

Available options:

vetting_comment,

rejection_reason,

internal_note,

notification,

status_update,

customer_inquiry,

admin_response

Response

Paginated list of comments.

data

object[]

required

Show child attributes

meta

object

required

JSON:API pagination metadata returned with every paginated list response. Page numbering is 1-based. page_size reports the number of items actually returned in data for this page; the requested size is taken from the page[size] query parameter.

Show child attributes

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const commentListResponse of client.dir.comments.list(
  '16635d38-75a6-4481-82e8-69af60e05011',
)) {
  console.log(commentListResponse.id);
}

import os
from telnyx import Telnyx

client = Telnyx(
    api_key=os.environ.get("TELNYX_API_KEY"),  # This is the default and can be omitted
)
page = client.dir.comments.list(
    dir_id="16635d38-75a6-4481-82e8-69af60e05011",
)
page = page.data[0]
print(page.id)

package main

import (
	"context"
	"fmt"

	"github.com/team-telnyx/telnyx-go"
	"github.com/team-telnyx/telnyx-go/option"
)

func main() {
	client := telnyx.NewClient(
		option.WithAPIKey("My API Key"),
	)
	page, err := client.Dir.Comments.List(
		context.TODO(),
		"16635d38-75a6-4481-82e8-69af60e05011",
		telnyx.DirCommentListParams{},
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", page)
}

package com.telnyx.sdk.example;

import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
import com.telnyx.sdk.models.dir.comments.CommentListPage;
import com.telnyx.sdk.models.dir.comments.CommentListParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        TelnyxClient client = TelnyxOkHttpClient.fromEnv();

        CommentListPage page = client.dir().comments().list("16635d38-75a6-4481-82e8-69af60e05011");
    }
}

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Telnyx\Client;
use Telnyx\Core\Exceptions\APIException;

$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');

try {
  $page = $client->dir->comments->list(
    '16635d38-75a6-4481-82e8-69af60e05011',
    commentType: 'vetting_comment',
    pageNumber: 1,
    pageSize: 20,
  );

  var_dump($page);
} catch (APIException $e) {
  echo $e->getMessage();
}

{
  "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",
      "author_name": null,
      "comment_type": "vetting_comment",
      "created_at": "2026-04-27T00:42:44.305835Z"
    }
  ],
  "meta": {
    "total_pages": 3,
    "total_results": 42,
    "page_number": 1,
    "page_size": 20
  }
}

Branded Calling

For AI Agents

List comments on a DIR

Authorizations

Path Parameters

Query Parameters

Response