GET/desk/api/v2/inboxes/{id}.json

Get a single inbox by id.

The following values are allowed in the includes query parameter:

  • inboxaliases
  • inboxcnames
  • inboxemailrefs
  • inboxtimetrackings
  • oauth2tokens
  • restricteddomains
  • ticketstatuses
  • users
  • all

Path Params

  • Name
    id
    Type
    integer
    required
    Description

Responses

  • Code
    200
    Type
    object
    Schema
    Description
    200 OK
    InboxAPIBody handles the get/create/update request/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

InboxAPIBody
{  "customDKIM": "string",  "inbox": {    "autoReplyEnabled": true,    "autoReplyFromUserId": 0,    "autoReplyMessage": "string",    "autoReplySubject": "string",    "clientOnly": true,    "createdAt": "2024-12-19T16:02:34.120Z",    "createdBy": {      "delete": true,      "id": 0,      "meta": {        "additionalProp": "Unknown Type: any"      },      "type": 0    },    "deletedAt": "2024-12-19T16:02:34.120Z",
Download Swagger