GET/desk/api/v2/inboxes.json
Get a paginated list of inboxes.
The following values are allowed in the filter query parameter:
- id
- name
- localPart
- useTeamworkMailServer
- smtpPassword
- smtpPasswordEncrypted
- smtpProvider
- smtpPort
- smtpSecurity
- smtpServer
- smtpUsername
- autoReplyEnabled
- autoReplySubject
- autoReplyMessage
- autoReplyFromUserId
- displayOrder
- spamThreshold
- happinessRatingEnabled
- happinessRatingMessage
- timeloggingEnabled
- timeloggingProjectId
- iconImage
- publicIconImage
- languageCode
- onClosedLock
- onClosedWait
- sendEmailsFrom
- signature
- usingOfficeHours
- isAdmin
- starred
- notificationOnly
- synced
- syncDays
- syncAccountId
- syncSubscriptionId
- includeTicketHistoryOnForward
- createdAt
- updatedAt
- createdBy
- updatedBy
- state
The following values are allowed in the orderBy query parameter:
- id
- name
- localPart
- useTeamworkMailServer
- smtpPassword
- smtpPasswordEncrypted
- smtpProvider
- smtpPort
- smtpSecurity
- smtpServer
- smtpUsername
- autoReplyEnabled
- autoReplySubject
- autoReplyMessage
- autoReplyFromUserId
- displayOrder
- spamThreshold
- happinessRatingEnabled
- happinessRatingMessage
- timeloggingEnabled
- timeloggingProjectId
- iconImage
- publicIconImage
- languageCode
- onClosedLock
- onClosedWait
- sendEmailsFrom
- signature
- usingOfficeHours
- isAdmin
- starred
- notificationOnly
- synced
- syncDays
- syncAccountId
- syncSubscriptionId
- includeTicketHistoryOnForward
- createdAt
- updatedAt
- createdBy
- updatedBy
- state
Responses
- Code
- 200
- Type
- object
- Schema
- Description
- 200 OK
InboxesAPIBody handles the listing response for inbox.
- 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
InboxesAPIBody
{ "inboxes": [ { "autoReplyEnabled": true, "autoReplyFromUserId": 0, "autoReplyMessage": "string", "autoReplySubject": "string", "createdAt": "2024-07-26T20:26:26.473Z", "createdBy": { "delete": true, "id": 0, "meta": {}, "type": 0 }, "deletedAt": "2024-07-26T20:26:26.473Z", "deletedBy": { "delete": true, "id": 0,