GET/desk/api/v2/conversations.json

Get a paginated list of conversations.

The following values are allowed in the filter query parameter:

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

The following values are allowed in the orderBy query parameter:

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

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-07-26T20:26:10.533Z",        "createdBy": {          "delete": true,          "id": 0,          "meta": {},          "type": 0        },        "deletedAt": "2024-07-26T20:26:10.533Z",        "deletedBy": {          "delete": true,          "id": 0,          "meta": {},          "type": 0        },
Download Swagger