Skip to main content
GET
Get inbox

Authorizations

Authorization
string
header
required

API key authentication. Use your API key as the bearer token.

Path Parameters

id
string<uuid>
required
Example:

"123e4567-e89b-12d3-a456-426614174000"

Response

Inbox details

id
string<uuid>
required
Example:

"123e4567-e89b-12d3-a456-426614174000"

organization_id
string<uuid>
required
name
string
required
Example:

"Support"

username
string
required
Example:

"support"

domain
string
required
Example:

"example.com"

reply_to
string
required

Reply-to address for outbound emails. Defaults to username@mail.domain when not set.

Example:

"support@mail.example.com"

from_address
string
required

Computed from address (username@domain) used for outbound sending

Example:

"support@example.com"

inbound_address
string
required

Computed inbound address (username@mail.domain) used for receiving emails

Example:

"support@mail.example.com"

signature_html
string | null
required

HTML signature content appended to outgoing transactional emails

Example:

"<p>Best regards,<br/>Support Team</p>"

signature_enabled
boolean
required

Whether to append the signature to outgoing transactional emails

Example:

false

slack_connection_id
string<uuid> | null
required

Slack OAuth connection ID for notifications

slack_channel_id
string | null
required

Slack channel ID where notifications are sent

slack_channel_name
string | null
required

Slack channel display name

slack_notifications_enabled
boolean
required

Whether Slack notifications are enabled for this inbox

Example:

false

unread_thread_count
integer
required

Number of unread threads in this inbox

Example:

3

created_at
string<date-time>
required
updated_at
string<date-time>
required