Skip to main content
GET
/
organizations
/
{organization_id}
Retrieve organization
curl --request GET \
  --url https://api.example.com/organizations/{organization_id}/ \
  --header 'X-Initdesk-Token: <api-key>'
{
  "id": 123,
  "public_id": "<string>",
  "name": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "created_by": {
    "id": 123,
    "email": "jsmith@example.com",
    "name": "<string>"
  },
  "support_email": "<string>",
  "deletion_plan": {
    "inactivity_detected_at": "2023-11-07T05:31:56Z",
    "deletion_at": "2023-11-07T05:31:56Z"
  },
  "subscription": {
    "plan_name": "<string>",
    "plan_metric": "<string>",
    "renews_at": "2023-11-07T05:31:56Z",
    "ends_at": "2023-11-07T05:31:56Z",
    "trial_ends_at": "2023-11-07T05:31:56Z",
    "trial_days_remaining": 123,
    "has_access_enabled": true
  },
  "customer_max_inactivity_period": 0,
  "customer_inactivity_reminder_period": 0,
  "site_url": "<string>",
  "description": "<string>",
  "email_from_name": "<string>",
  "email_subject_prefix": "<string>",
  "enable_csat": true,
  "enable_auto_tagging": true,
  "enable_cc_email_routing": true
}

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

organization_id
string
required

Response

200 - application/json
id
integer
required
read-only
public_id
string
required
Maximum string length: 32
name
string
required
Maximum string length: 255
created_at
string<date-time>
required
read-only
updated_at
string<date-time>
required
read-only
created_by
object
required
support_email
string
required
read-only
deletion_plan
object
required
subscription
object
required

Read-only subscription payload for organization and billing endpoints.

customer_max_inactivity_period
integer
required
read-only
Required range: x >= -1
customer_inactivity_reminder_period
integer
required
read-only
Required range: x >= -1
site_url
string<uri>
Maximum string length: 200
description
string
email_from_name
string
Maximum string length: 32
email_subject_prefix
string
Maximum string length: 32
enable_csat
boolean

Beta feature. Contact support@initdesk.com if you want to try it.

enable_auto_tagging
boolean

When a ticket arrives, automatically tags every ticket (except spam).

enable_cc_email_routing
boolean

When enabled, inbound email is routed using To/Cc headers, deduplicated across inboxes, and external recipients are stored for agent replies.