Skip to main content

List all comments of a porting order

GET 
/porting_orders/:id/comments

Returns a list of all comments of a porting order.

Request ​

Path Parameters

    id uuidrequired

    Porting Order id

Query Parameters

    page[number] integer

    Possible values: >= 1

    Default value: 1

    The page number to load

    page[size] integer

    Possible values: >= 1 and <= 250

    Default value: 20

    The size of the page

Responses ​

200: Successful response

Schema

    data

    object[]

  • Array [

    • id uuid
    body string

    Body of comment

    porting_order_id uuid
    user_type string

    Possible values: [admin, user, system]

    Indicates whether this comment was created by a Telnyx Admin, user, or system

    user_id uuid

    The ID of the user who created this comment

    user_email email

    The email address of the user who created this comment

    record_type string

    Identifies the type of the resource.

    created_at date-time

    ISO 8601 formatted date indicating when the resource was created.

  • ]

    • meta

    object

    total_pages integer
    total_results integer
    page_number integer
    page_size integer

401: Unauthorized

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

Request samples

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

Response samples

{
  "data": [
    {
      "id": "f1486bae-f067-460c-ad43-73a92848f902",
      "body": "Great experience so far",
      "porting_order_id": "f1486bae-f067-460c-ad43-73a92848f902",
      "user_type": "user",
      "user_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
      "user_email": "user@example.com",
      "record_type": "porting_comment",
      "created_at": "2021-03-19T10:07:15.527Z"
    }
  ],
  "meta": {
    "total_pages": 3,
    "total_results": 55,
    "page_number": 2,
    "page_size": 25
  }
}