Skip to main content

Retrieve all comments

GET 

/comments

Retrieve all comments

Request

Query Parameters

    filter[comment_record_type] stringrequired

    Record type that the comment relates to i.e number_order, sub_number_order or number_order_phone_number

    filter[comment_record_id] stringrequired

    ID of the record the comments relate to

Responses

200: An array of Comment Responses

Schema

    data

    Comment[]

  • Array [

  • id uuid
    body string
    commenter string
    commenter_type string

    Possible values: [admin, user]

    comment_record_type string

    Possible values: [number_order, sub_number_order, number_order_phone_number]

    comment_record_id uuid
    read_at datetime

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

    created_at datetime

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

    updated_at datetime

    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

default: Unexpected error

Schema

    errors

    Error[]

  • Array [

  • code integerrequired
    title stringrequired
    detail string

    source

    object

    pointer json-pointer

    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.

  • ]

Loading...