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:

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

The following values are allowed in the orderBy query parameter:

  • agent

  • businesshours

  • businesshours.id

  • businesshours.name

  • companies.id

  • companies.name

  • company

  • contact

  • createdAt

  • customer

  • customers.id

  • customers.name

  • deletedAt

  • deletedBy

  • happinessSurveySentAt

  • id

  • inbox

  • inboxes.id

  • messages.customers.id

  • messages.id

  • messages.messageId

  • originalRecipient

  • previewText

  • priorities.id

  • priority

  • priority

  • projects.id

  • resolutionTimeMins

  • responseTimeMins

  • reviewStatus

  • source

  • spam_rules

  • spam_score

  • state

  • status

  • statuses.id

  • subject

  • tags.id

  • tasks.id

  • tickets_users_deck.createdAt

  • type

  • updatedAt

  • updatedBy

  • users.id

  • users.name

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

  • businesshours

  • companies

  • companycustomers

  • contacts

  • customers

  • customerticketsreads

  • customfieldoptions

  • customfields

  • files

  • happinessratingoptions

  • happinessratings

  • inboxes

  • likes

  • messages

  • notifications

  • pinnednotes

  • reactions

  • reviewcomments

  • scheduledemails

  • sentiments

  • tags

  • threademailrefs

  • threadreactions

  • ticketactivities

  • ticketpriorities

  • ticketreviews

  • tickets

  • ticketsources

  • ticketstatuses

  • tickettypes

  • timelogs

  • users

  • all

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-11-21T11:55:21.018Z",