GET/desk/api/v2/conversations.json

Get a paginated list of conversations.

The following values are allowed in the filter query parameter:

  • contactId
  • createdAt
  • deletedAt
  • id
  • state
  • ticket_id
  • token
  • updatedAt

The following values are allowed in the orderBy query parameter:

  • contactId

  • createdAt

  • deletedAt

  • id

  • state

  • ticket_id

  • token

  • updatedAt

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

  • conversationmessages

  • customers

  • users

  • all

Responses

  • Code
    200
    Type
    object
    Schema
    Description
    200 OK
    ConversationsAPIBody handles the listing response for conversation.
  • 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

ConversationsAPIBody
{  "conversations": [    {      "contact": {        "createdAt": "2024-10-10T18:19:43.547Z",        "createdBy": {          "delete": true,          "id": 0,          "meta": {            "additionalProp": "Unknown Type: any"          },          "type": 0        },        "deletedAt": "2024-10-10T18:19:43.547Z",        "deletedBy": {          "delete": true,          "id": 0,          "meta": {