GET/desk/api/v2/tickets/{ticketId}/messages.json

Get a paginated list of messages for a ticket.

The following values are allowed in the filter query parameter:

  • assigningUser
  • contact
  • createdAt
  • editMethod
  • emailMessageId
  • happinessrating
  • helpdoc
  • htmlBody
  • id
  • isPinned
  • mergedAt
  • s3link
  • state
  • status
  • taskId
  • textBody
  • threadType
  • ticket
  • updatedAt
  • updatedBy
  • viewedByCustomerAt

The following values are allowed in the orderBy query parameter:

  • assigningUser

  • contact

  • createdAt

  • createdAt

  • editMethod

  • emailMessageId

  • happinessrating

  • helpdoc

  • htmlBody

  • id

  • isPinned

  • mergedAt

  • s3link

  • state

  • status

  • taskId

  • textBody

  • threadType

  • ticket

  • updatedAt

  • updatedBy

  • viewedByCustomerAt

         The following values are allowed in the [includes](https://apidocs.teamwork.com/guides/desk/relationships-and-includes) query parameter:

  • contacts

  • customers

  • files

  • happinessratings

  • metadata

  • reviewcomments

  • sentiments

  • ticketstatuses

  • users

  • all

Path Params

  • Name
    ticketId
    Type
    integer
    required
    Description

Responses

  • Code
    200
    Type
    object
    Schema
    Description
    200 OK
  • Code
    400
    Type
    object
    Schema
    Description
    400 Bad Request
    Validator hold the validation errors. Typically you shouldn't create this directly but use the New() function.

Examples

200 OK

ThreadsAPIBody
{  "included": {    "addresses": [      {        "city": "string",        "country": "string",        "firstLine": "string",        "id": 0,        "postalCode": "string",        "secondLine": "string",        "state": "string"      }    ],    "agentsnotified": [      {        "autoFollowOnCC": true,        "avatarURL": "string",        "createdAt": "2024-10-10T18:19:26.131Z",
Download Swagger