Get a paginated list of the tickets a smart inbox holds.
This is the ticket listing narrowed by the smart inbox's conditions, so every filter, ordering and include the ticket listing accepts works here too, and the record count is over the same tickets as the page.
Query:
groupId: only return the tickets of this group of the smart inbox's own
grouping, as GET /v2/smartinboxes/counts.json reports it {int}.
Tickets with no value for the grouping are in group -1.
The following values are allowed in the [filter](https://apidocs.teamwork.com/guides/desk/filtering-api-results) query parameter:
- agent
- businesshours
- company
- contact
- createdAt
- customer
- deletedAt
- deletedBy
- happinessSurveySentAt
- id
- inbox
- originalRecipient
- previewText
- priority
- resolutionTimeMins
- responseTimeMins
- sla
- slaBreachedAt
- 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
-
sla
-
slaBreachedAt
-
slas.breachedAt
-
slas.id
-
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
-
jobstatuses
-
likes
-
messages
-
notifications
-
pinnednotes
-
reactions
-
reviewcomments
-
scheduledemails
-
sentiments
-
slas
-
slathreads
-
slatickets
-
tags
-
tasktickets
-
threademailrefs
-
threadreactions
-
threadsummaries
-
ticketactivities
-
ticketpriorities
-
ticketreviews
-
tickets
-
ticketsources
-
ticketstatuses
-
ticketsummaries
-
tickettypes
-
timelogs
-
trends
-
users
-
all
Path Params
- Name
id- Type
- integer
- required
- Description
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.
200 OK
{ "groups": { "groups": [ { "keys": { "additionalProp": "Unknown Type: any" }, "values": { "additionalProp": "Unknown Type: any" } } ], "truncated": true }, "included": { "addresses": [ { "city": "string",