Retrieve all comments

GET 
/comments

Retrieve all comments

Query Parameters

filter object

Consolidated filter parameter (deepObject style). Originally: filter[comment_record_type], filter[comment_record_id]

200: An array of Comment Responses

application/json

• Schema
• Example (from schema)

Schema

data

object[]

Array [

id uuid

body string

commenter string

commenter_type string

Possible values: [admin, user]

comment_record_type string

Possible values: [sub_number_order, requirement_group]

comment_record_id uuid

read_at date-time

An ISO 8901 datetime string for when the comment was read.

created_at date-time

An ISO 8901 datetime string denoting when the comment was created.

updated_at date-time

An ISO 8901 datetime string for when the comment was updated.

]

meta

object

total_pages integer

total_results integer

page_number integer

page_size integer

{
  "data": [
    {
      "id": "12ade33a-21c0-473b-b055-b3c836e1c292",
      "body": "Hi there, ....",
      "commenter": "user@company.com",
      "commenter_type": "user",
      "comment_record_type": "sub_number_order",
      "comment_record_id": "8ffb3622-7c6b-4ccc-b65f-7a3dc0099576",
      "read_at": "2018-01-01T00:00:00.000000Z",
      "created_at": "2018-01-01T00:00:00.000000Z",
      "updated_at": "2018-01-01T00:00:00.000000Z"
    }
  ],
  "meta": {
    "total_pages": 3,
    "total_results": 55,
    "page_number": 2,
    "page_size": 25
  }
}

default: Unexpected error

application/json

• Schema
• Example (from schema)

Schema

errors

object[]

Array [

code stringrequired

title stringrequired

detail string

source

object

pointer string

JSON pointer (RFC6901) to the offending entity.

parameter string

Indicates which query parameter caused the error.

meta

object

url string

URL with additional information on the error.

]

{
  "errors": [
    {
      "code": "10007",
      "title": "Unexpected error",
      "detail": "An unexpected error occured.",
      "source": {
        "pointer": "/base",
        "parameter": "string"
      },
      "meta": {
        "url": "https://developers.telnyx.com/docs/overview/errors/10015"
      }
    }
  ]
}

Request samples

• cURL

---

curl -L 'https://api.telnyx.com/v2/comments' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Response samples

• 200
• default

---

{
  "data": [
    {
      "id": "12ade33a-21c0-473b-b055-b3c836e1c292",
      "body": "Hi there, ....",
      "commenter": "user@company.com",
      "commenter_type": "user",
      "comment_record_type": "sub_number_order",
      "comment_record_id": "8ffb3622-7c6b-4ccc-b65f-7a3dc0099576",
      "read_at": "2018-01-01T00:00:00.000000Z",
      "created_at": "2018-01-01T00:00:00.000000Z",
      "updated_at": "2018-01-01T00:00:00.000000Z"
    }
  ],
  "meta": {
    "total_pages": 3,
    "total_results": 55,
    "page_number": 2,
    "page_size": 25
  }
}

{
  "errors": [
    {
      "code": "10007",
      "title": "Unexpected error",
      "detail": "An unexpected error occured.",
      "source": {
        "pointer": "/base",
        "parameter": "string"
      },
      "meta": {
        "url": "https://developers.telnyx.com/docs/overview/errors/10015"
      }
    }
  ]
}