ticketing/comments

Retrieve Comment

Retrieve a Comment from any connected Ticketing software

get/ticketing/comments/{id}

Path parameters

idstring required

id of the comment you want to retrive.

Query parameters

remote_databoolean

Set to true to include data from the original Ticketing software.

Headers

x-connection-tokenstring required

The connection token

Response

prev_cursorstring nullable required
next_cursorstring nullable required

Example response

{
  "data": [
    {
      "body": "Assigned to Eric !",
      "html_body": "<p>Assigned to Eric !</p>",
      "creator_type": "USER",
      "ticket_id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
      "contact_id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
      "user_id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
      "attachments": [
        "801f9ede-c698-4e66-a7fc-48d19eebaa4f"
      ],
      "id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
      "remote_id": "id_1",
      "remote_data": {
        "fav_dish": "broccoli",
        "fav_color": "red"
      },
      "created_at": "2024-10-01T12:00:00Z",
      "modified_at": "2024-10-01T12:00:00Z"
    }
  ]
}

Changes

Changed in 7 of the 18 revisions of this API.4428

    • removed the CONTACT enum value from the allOf[subschema #2]/data/items/creator_type response property for the response status 200

      response-property-enum-value-removed

    • removed the USER enum value from the allOf[subschema #2]/data/items/creator_type response property for the response status 200

      response-property-enum-value-removed

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • added UnifiedTicketingAttachmentOutput subschema #1 to the allOf[subschema #2]/data/items/attachments/items/ response property oneOf list for the response status 200

      response-property-one-of-added

    • the allOf[subschema #2]/data/items/attachments/items/ response's property type/format changed from string/ to / for status 200

      response-property-type-changed

    • added the new CONTACT enum value to the allOf[subschema #2]/data/items/creator_type response property for the response status 200

      response-property-enum-value-added

    • added the new USER enum value to the allOf[subschema #2]/data/items/creator_type response property for the response status 200

      response-property-enum-value-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • ca213ae36b7f201See the full diff
    • the response property allOf[PaginatedDto]/next_cursor became nullable for the status 200

      response-property-became-nullable

    • the response property allOf[PaginatedDto]/prev_cursor became nullable for the status 200

      response-property-became-nullable

    • the response property allOf[subschema #2]/data/items/attachments became nullable for the status 200

      response-property-became-nullable

    • the response property allOf[subschema #2]/data/items/body became nullable for the status 200

      response-property-became-nullable

    • the response property allOf[subschema #2]/data/items/contact_id became nullable for the status 200

      response-property-became-nullable

    • the response property allOf[subschema #2]/data/items/created_at became nullable for the status 200

      response-property-became-nullable

    • the response property allOf[subschema #2]/data/items/creator_type became nullable for the status 200

      response-property-became-nullable

    • the response property allOf[subschema #2]/data/items/html_body became nullable for the status 200

      response-property-became-nullable

    • the response property allOf[subschema #2]/data/items/id became nullable for the status 200

      response-property-became-nullable

    • the response property allOf[subschema #2]/data/items/is_private became nullable for the status 200

      response-property-became-nullable

    • the response property allOf[subschema #2]/data/items/modified_at became nullable for the status 200

      response-property-became-nullable

    • the response property allOf[subschema #2]/data/items/remote_data became nullable for the status 200

      response-property-became-nullable

    • the response property allOf[subschema #2]/data/items/remote_id became nullable for the status 200

      response-property-became-nullable

    • the response property allOf[subschema #2]/data/items/ticket_id became nullable for the status 200

      response-property-became-nullable

    • the response property allOf[subschema #2]/data/items/user_id became nullable for the status 200

      response-property-became-nullable

    • the response property allOf[subschema #2]/data/items/created_at became optional for the status 200

      response-property-became-optional

    • the response property allOf[subschema #2]/data/items/modified_at became optional for the status 200

      response-property-became-optional

    • the response property allOf[subschema #2]/data/items/remote_data became optional for the status 200

      response-property-became-optional

    • the allOf[subschema #2]/data/items/created_at response's property type/format changed from object/ to string/date-time for status 200

      response-property-type-changed

    • the allOf[subschema #2]/data/items/modified_at response's property type/format changed from object/ to string/date-time for status 200

      response-property-type-changed

    • the endpoint scheme security bearer was removed from the API

      api-security-removed

    This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • the allOf[subschema #2]/data/items/created_at response's property type/format changed from string/date-time to object/ for status 200

      response-property-type-changed

    • the allOf[subschema #2]/data/items/modified_at response's property type/format changed from string/date-time to object/ for status 200

      response-property-type-changed

    • the endpoint scheme security bearer was added to the API

      api-security-added

    • the response property allOf[subschema #2]/data/items/created_at became required for the status 200

      response-property-became-required

    • the response property allOf[subschema #2]/data/items/modified_at became required for the status 200

      response-property-became-required

    • the response property allOf[subschema #2]/data/items/remote_data became required for the status 200

      response-property-became-required

    This revision also has 8 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • the response property allOf[PaginatedDto]/next_cursor became nullable for the status 200

      response-property-became-nullable

    • the response property allOf[PaginatedDto]/prev_cursor became nullable for the status 200

      response-property-became-nullable

    • the response property allOf[subschema #2]/data/items/attachments became nullable for the status 200

      response-property-became-nullable

    • the response property allOf[subschema #2]/data/items/body became nullable for the status 200

      response-property-became-nullable

    • the response property allOf[subschema #2]/data/items/contact_id became nullable for the status 200

      response-property-became-nullable

    • the response property allOf[subschema #2]/data/items/created_at became nullable for the status 200

      response-property-became-nullable

    • the response property allOf[subschema #2]/data/items/creator_type became nullable for the status 200

      response-property-became-nullable

    • the response property allOf[subschema #2]/data/items/html_body became nullable for the status 200

      response-property-became-nullable

    • the response property allOf[subschema #2]/data/items/id became nullable for the status 200

      response-property-became-nullable

    • the response property allOf[subschema #2]/data/items/is_private became nullable for the status 200

      response-property-became-nullable

    • the response property allOf[subschema #2]/data/items/modified_at became nullable for the status 200

      response-property-became-nullable

    • the response property allOf[subschema #2]/data/items/remote_data became nullable for the status 200

      response-property-became-nullable

    • the response property allOf[subschema #2]/data/items/remote_id became nullable for the status 200

      response-property-became-nullable

    • the response property allOf[subschema #2]/data/items/ticket_id became nullable for the status 200

      response-property-became-nullable

    • the response property allOf[subschema #2]/data/items/user_id became nullable for the status 200

      response-property-became-nullable

    • the response property allOf[subschema #2]/data/items/created_at became optional for the status 200

      response-property-became-optional

    • the response property allOf[subschema #2]/data/items/modified_at became optional for the status 200

      response-property-became-optional

    • the response property allOf[subschema #2]/data/items/remote_data became optional for the status 200

      response-property-became-optional

    • the allOf[subschema #2]/data/items/created_at response's property type/format changed from object/ to string/date-time for status 200

      response-property-type-changed

    • the allOf[subschema #2]/data/items/modified_at response's property type/format changed from object/ to string/date-time for status 200

      response-property-type-changed

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • the endpoint scheme security bearer was removed from the API

      api-security-removed