v52

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-311,1941,9384.1 MB

Phone Number Orders

Retrieve all comments

get/comments

Query parameters

comment_record_idstring

ID of the record the comments relate to

comment_record_type'sub_number_order' | 'requirement_group'

Record type that the comment relates to

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

{
  "comment_record_id": "8ffb3622-7c6b-4ccc-b65f-7a3dc0099576",
  "comment_record_type": "sub_number_order"
}

Response

An array of Comment Responses

Example response

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