Skip to main content
GET
Retrieve inbox

Authorizations

X-Initdesk-Token
string
header
required

Path Parameters

pk
integer
required

A unique integer value identifying this Inbox.

organization_id
string
required

Response

200 - application/json
id
integer
required
read-only
name
string
required
Maximum string length: 64
email_prefix
string
required
Maximum string length: 32
Pattern: ^[a-zA-Z0-9._%-]+$
inbox_email_address
string
required
read-only

Email-only convenience field. Prefer channel_connections (type=email).external_identifier for multi-channel inboxes.

channel_connections
object[]
required
read-only
created_at
string<date-time>
required
read-only
updated_at
string<date-time>
required
read-only
is_default
boolean

This inbox will be used as the default (and catch all) for the organization.

enable_auto_reply
boolean

Automatically reply to new tickets with a welcome message.

enable_inactivity_reminders
boolean

Send reminder emails to customers when tickets are inactive.

enable_auto_close_inactive_tickets
boolean

Automatically close tickets after a specified period of inactivity.

customer_max_inactivity_period
integer
Required range: 0 <= x <= 2147483647
customer_inactivity_reminder_period
integer
Required range: 0 <= x <= 2147483647
signature
string

This signature will be appended to outgoing emails.

email_from_name
string

Optional custom sender display name for outgoing emails from this inbox. Falls back to the organization email from name when unset.

Maximum string length: 32
customer_interaction_style
enum<string>

Helpdesk exposes ticket numbers in customer emails and messages; conversational keeps interactions natural without ticket references.

  • helpdesk - Helpdesk
  • conversational - Conversational
Available options:
helpdesk,
conversational