Skip to main content
GET
/
organizations
/
{organization_id}
/
inboxes
/
{pk}
Retrieve inbox
curl --request GET \
  --url https://api.initdesk.com/organizations/{organization_id}/inboxes/{pk}/ \
  --header 'X-Initdesk-Token: <api-key>'
{
  "id": 123,
  "name": "<string>",
  "email_prefix": "<string>",
  "inbox_email_address": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "is_default": true,
  "enable_auto_reply": true,
  "enable_inactivity_reminders": true,
  "enable_auto_close_inactive_tickets": true,
  "customer_max_inactivity_period": 1073741823,
  "customer_inactivity_reminder_period": 1073741823,
  "signature": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://developers.initdesk.com/llms.txt

Use this file to discover all available pages before exploring further.

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