GET/desk/api/v2/inboxes.json

Get a paginated list of inboxes.

The following values are allowed in the filter query parameter:

  • autoReplyEnabled
  • autoReplyFromUserId
  • autoReplyMessage
  • autoReplySubject
  • clientOnly
  • createdAt
  • createdBy
  • 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 orderBy query parameter:

  • autoReplyEnabled

  • autoReplyFromUserId

  • autoReplyMessage

  • autoReplySubject

  • clientOnly

  • createdAt

  • createdBy

  • 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
    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.

Examples

200 OK

InboxesAPIBody
{  "inboxes": [    {      "autoReplyEnabled": true,      "autoReplyFromUserId": 0,      "autoReplyMessage": "string",      "autoReplySubject": "string",      "clientOnly": true,      "createdAt": "2024-10-18T23:59:26.491Z",      "createdBy": {        "delete": true,        "id": 0,        "meta": {          "additionalProp": "Unknown Type: any"        },        "type": 0      },      "deletedAt": "2024-10-18T23:59:26.491Z",
Download Swagger