GET/desk/api/v2/search/tickets.json

Search for tickets

Query Params

  • Name
    updatedAtTo
    Type
    string
    Description
    UpdatedAtTo is the end date to match ticket's updatedAt value
  • Name
    updatedAtFrom
    Type
    string
    Description
    UpdatedAtFrom is the starting date to match ticket's updatedAt value
  • Name
    timeRange
    Type
    string
    Description
  • Name
    search
    Type
    string
    Description
    Search is a search string to filter by (searches subject, body, customer
    name, and email)
  • Name
    orderMode
    Type
    string
    Description
    Order in either ascending or descending
    Default
    asc
  • Name
    orderBy
    Type
    string
    Description
    A comma separated list of field names to order by. A list of orderable fields
    is included in the endpoint description
  • Name
    lastUpdated
    Type
    string
    Description
  • Name
    ticket
    Type
    integer
    Description
    TicketID allows you to specify a specific ticket ID to get
    it will only return one ticket or none
  • Name
    task
    Type
    integer
    Description
    TaskID is a task ID to filter by
  • Name
    onlyWithAttachment
    Type
    boolean
    Description
    OnlyWithAttachment filters tickets to only those with attachments
  • Name
    onlyUntagged
    Type
    boolean
    Description
  • Name
    omitMerged
    Type
    boolean
    Description
    OmitMerged filters out merged tickets
  • Name
    includeArchivedAgents
    Type
    boolean
    Description
  • Name
    types
    Type
    array[integer]
    Description
    Types to filter by. If empty, all types are included.
    Format
    Comma separated values
  • Name
    twCompanyIds
    Type
    array[integer]
    Description
    TWCompanyIDs is a list of Teamwork company IDs to filter by
    Format
    Comma separated values
  • Name
    teams
    Type
    array[integer]
    Description
    Teams is a list of team IDs to filter by
    Format
    Comma separated values
  • Name
    taskStatuses
    Type
    array[string]
    Description
    TaskStatuses is a list of task statuses to filter by
    Format
    Comma separated values
    Allowed values
    • active
    • complete
  • Name
    tags
    Type
    array[integer]
    Description
    Tags to filter by. If empty, all tags are included.
    Format
    Comma separated values
  • Name
    subjectKeywords
    Type
    array[string]
    Description
    Format
    Comma separated values
  • Name
    statuses
    Type
    array[integer]
    Description
    Statuses to filter by. If empty, all statuses are included.
    Format
    Comma separated values
  • Name
    sources
    Type
    array[integer]
    Description
    Sources to filter by. If empty, all sources are included.
    Format
    Comma separated values
  • Name
    priorities
    Type
    array[integer]
    Description
    Priorities to filter by. If empty, all priorities are included.
    Format
    Comma separated values
  • Name
    inboxes
    Type
    array[integer]
    Description
    Inboxes to filter by. If empty, all inboxes are included.
    Format
    Comma separated values
  • Name
    helpdocSites
    Type
    array[integer]
    Description
    HelpdocSites is a list of helpdoc site IDs to filter by
    Format
    Comma separated values
  • Name
    excludeTags
    Type
    array[integer]
    Description
    ExcludeTags to filter out tags. If empty, no tags are excluded.
    Format
    Comma separated values
  • Name
    excludeInboxes
    Type
    array[integer]
    Description
    ExcludeInboxes to filter out inboxes. If empty, no inboxes are excluded.
    Format
    Comma separated values
  • Name
    customfields
    Type
    array[string]
    Description
    Format
    Comma separated values
  • Name
    customers
    Type
    array[integer]
    Description
    Customers is a list of customer IDs to filter by
    Format
    Comma separated values
  • Name
    companies
    Type
    array[integer]
    Description
    Companies to filter by. If empty, all companies are included.
    Format
    Comma separated values
  • Name
    agents
    Type
    array[integer]
    Description
    Agents to filter by. If empty, all agents are included.
    Format
    Comma separated values

Responses

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

TicketAPIBody
{  "delayed": true,  "included": {    "addresses": [      {        "city": "string",        "country": "string",        "firstLine": "string",        "id": 0,        "postalCode": "string",        "secondLine": "string",        "state": "string"      }    ],    "agentsnotified": [      {        "autoFollowOnCC": true,        "avatarURL": "string",