GET/desk/api/v2/tickets.json

Get a paginated list of tickets based on current user permissions.

The following values are allowed in the filter query parameter:

  • id
  • subject
  • previewText
  • originalRecipient
  • responseTimeMins
  • resolutionTimeMins
  • happinessSurveySentAt
  • spam_score
  • spam_rules
  • customer
  • contact
  • inbox
  • agent
  • status
  • priority
  • source
  • type
  • businesshours
  • company
  • createdAt
  • updatedAt
  • deletedAt
  • updatedBy
  • deletedBy
  • state

The following values are allowed in the orderBy query parameter:

  • id
  • subject
  • previewText
  • originalRecipient
  • responseTimeMins
  • resolutionTimeMins
  • happinessSurveySentAt
  • spam_score
  • spam_rules
  • customer
  • contact
  • inbox
  • agent
  • status
  • priority
  • source
  • type
  • businesshours
  • company
  • createdAt
  • updatedAt
  • deletedAt
  • updatedBy
  • deletedBy
  • state
  • users.id
  • users.name
  • customers.id
  • customers.name
  • priority
  • priorities.id
  • tags.id
  • messages.id
  • messages.messageId
  • messages.customers.id
  • companies.id
  • companies.name
  • tasks.id
  • inboxes.id
  • statuses.id
  • businesshours.id
  • businesshours.name
  • reviewStatus
  • tickets_users_deck.createdAt

Responses

  • Code
    200
    Type
    object
    Schema
    Description
    200 OK
    TicketsAPIBody is the request/response format for bulk ticket API calls
  • 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

TicketsAPIBody
{  "included": {    "addresses": [      {        "city": "string",        "country": "string",        "firstLine": "string",        "id": 0,        "postalCode": "string",        "secondLine": "string",        "state": "string"      }    ],    "agentsnotified": [      {        "autoFollowOnCC": true,        "avatarURL": "string",        "createdAt": "2024-04-12T16:21:59.318Z",