Get a paginated list of inboxes.
The following values are allowed in the filter query parameter:
- autoReplyEnabled
- autoReplyFromUserId
- autoReplyMessage
- autoReplySubject
- clientOnly
- createdAt
- createdBy
- deletedAt
- deletedBy
- displayOrder
- emailForwardingState
- happinessRatingEnabled
- happinessRatingMessage
- iconImage
- id
- includeTicketHistoryOnForward
- isAdmin
- languageCode
- localPart
- name
- notificationsOnly
- onClosedLock
- onClosedWait
- publicIconImage
- sendEmailsFrom
- signature
- smtpPassword
- smtpPort
- smtpProvider
- smtpSecurity
- smtpServer
- smtpUsername
- spamThreshold
- starred
- state
- syncAccountId
- syncDays
- syncSubscriptionId
- synced
- ticketstatus
- timeloggingEnabled
- timeloggingProjectId
- type
- updatedAt
- updatedBy
- useTeamworkMailServer
- user
- usingOfficeHours
The following values are allowed in the orderBy query parameter:
-
autoReplyEnabled
-
autoReplyFromUserId
-
autoReplyMessage
-
autoReplySubject
-
clientOnly
-
createdAt
-
createdBy
-
deletedAt
-
deletedBy
-
displayOrder
-
email
-
emailForwardingState
-
happinessRatingEnabled
-
happinessRatingMessage
-
iconImage
-
id
-
includeTicketHistoryOnForward
-
isAdmin
-
languageCode
-
localPart
-
name
-
notificationsOnly
-
onClosedLock
-
onClosedWait
-
publicIconImage
-
sendEmailsFrom
-
signature
-
smtpPassword
-
smtpPort
-
smtpProvider
-
smtpSecurity
-
smtpServer
-
smtpUsername
-
spamThreshold
-
starred
-
state
-
syncAccountId
-
syncDays
-
syncSubscriptionId
-
synced
-
ticketstatus
-
timeloggingEnabled
-
timeloggingProjectId
-
type
-
updatedAt
-
updatedBy
-
useTeamworkMailServer
-
user
-
usingOfficeHours
The following values are allowed in the [includes](https://apidocs.teamwork.com/guides/desk/relationships-and-includes) query parameter: -
inboxaliases
-
inboxcnames
-
inboxemailrefs
-
inboxtimetrackings
-
oauth2tokens
-
restricteddomains
-
ticketstatuses
-
users
-
all
Responses
- Code
- 200
- Type
- object
- Schema
- Description
- 200 OK
- 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
{
"inboxcounts": [
{
"count": 0,
"displayOrder": 0,
"inbox": {
"delete": true,
"id": 0,
"meta": {
"additionalProp": "Unknown Type: any"
},
"type": 0
},
"status": "string"
}
],
"scheduled": [
{
"count": 0,
"displayOrder": 0,
"inbox": {
"delete": true,
"id": 0,
"meta": {
"additionalProp": "Unknown Type: any"
},
"type": 0
},
"status": "string"
}
],
"trainingwheelcounts": [
{
"count": 0,
"displayOrder": 0,
"inbox": {
"delete": true,
"id": 0,
"meta": {
"additionalProp": "Unknown Type: any"
},
"type": 0
},
"status": "string"
}
]
}