List all comments for a portout request

GET 
/portouts/:id/comments

Returns a list of comments for a portout request.

Request

Path Parameters

id uuidrequired

Portout id

Responses

200: Portout Comments

application/json

• Schema
• Example (from schema)

Schema

data

PortoutComment[]

Array [

id stringrequired

record_type string

Identifies the type of the resource.

body stringrequired

Comment body

portout_id string

Identifies the associated port request

user_id stringrequired

Identifies the user who created the comment. Will be null if created by Telnyx Admin

created_at stringrequired

Comment creation timestamp in ISO 8601 format

]

meta

object

total_pages double

Total number of pages based on pagination settings

total_results double

Total number of results

page_number double

Current Page based on pagination settings (included when defaults are used.)

page_size double

Number of results to return per page based on pagination settings (included when defaults are used.)

{
  "data": [
    {
      "id": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0",
      "record_type": "portout",
      "body": "This is a comment",
      "portout_id": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0",
      "user_id": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0",
      "created_at": "2018-02-02T22:25:27.521Z"
    }
  ],
  "meta": {
    "total_pages": 13,
    "total_results": 13,
    "page_number": 3,
    "page_size": 1
  }
}

401: Unauthorized

404: Resource not found

422: Unprocessable entity. Check message field in response for details.

Loading...