Get early access

REST API reference

Every endpoint of the ChaosDesk REST API (162 operations), generated from the API's OpenAPI 3.2.0 document, version 1.0.0.

openapi.jsonGenerate a client or import into your tools Interactive explorerTry requests in the browser AuthenticationTokens, scopes and limits
API tokens3
  • GET/api/api_tokens
  • POST/api/api_tokens
  • DELETE/api/api_tokens/{id}
 Assignment rules5
  • GET/api/assignment_rules
  • POST/api/assignment_rules
  • GET/api/assignment_rules/{id}
  • PATCH/api/assignment_rules/{id}
  • and 1 more
 Attachments1
  • GET/api/attachments/{id}
 Auto merge rules5
  • GET/api/auto_merge_rules
  • POST/api/auto_merge_rules
  • GET/api/auto_merge_rules/{id}
  • PATCH/api/auto_merge_rules/{id}
  • and 1 more
 Automations5
  • GET/api/automations
  • POST/api/automations
  • GET/api/automations/{id}
  • PATCH/api/automations/{id}
  • and 1 more
 Brands4
  • GET/api/brands
  • POST/api/brands
  • GET/api/brands/{id}
  • PATCH/api/brands/{id}
 Business schedules5
  • GET/api/business_schedules
  • POST/api/business_schedules
  • GET/api/business_schedules/{id}
  • PATCH/api/business_schedules/{id}
  • and 1 more
 Contextual workspaces5
  • GET/api/contextual_workspaces
  • POST/api/contextual_workspaces
  • GET/api/contextual_workspaces/{id}
  • PATCH/api/contextual_workspaces/{id}
  • and 1 more
 CSAT reasons5
  • GET/api/csat_reasons
  • POST/api/csat_reasons
  • GET/api/csat_reasons/{id}
  • PATCH/api/csat_reasons/{id}
  • and 1 more
 Custom agent status5
  • GET/api/custom_agent_statuses
  • POST/api/custom_agent_statuses
  • GET/api/custom_agent_statuses/{id}
  • PATCH/api/custom_agent_statuses/{id}
  • and 1 more
 Customer context1
  • GET/api/users/{id}/customer_context
 Dynamic content items5
  • GET/api/dynamic_content_items
  • POST/api/dynamic_content_items
  • GET/api/dynamic_content_items/{id}
  • PATCH/api/dynamic_content_items/{id}
  • and 1 more
 Email templates5
  • GET/api/email_templates
  • GET/api/email_templates/{key}
  • PATCH/api/email_templates/{key}
  • DELETE/api/email_templates/{key}
  • and 1 more
 Groups5
  • GET/api/groups
  • POST/api/groups
  • GET/api/groups/{id}
  • PATCH/api/groups/{id}
  • and 1 more
 Holidays5
  • GET/api/holidays
  • POST/api/holidays
  • GET/api/holidays/{id}
  • PATCH/api/holidays/{id}
  • and 1 more
 Macros5
  • GET/api/macros
  • POST/api/macros
  • GET/api/macros/{id}
  • PATCH/api/macros/{id}
  • and 1 more
 Organization fields5
  • GET/api/organization_fields
  • POST/api/organization_fields
  • GET/api/organization_fields/{id}
  • PATCH/api/organization_fields/{id}
  • and 1 more
 Organizations5
  • GET/api/organizations
  • POST/api/organizations
  • GET/api/organizations/{id}
  • PATCH/api/organizations/{id}
  • and 1 more
 Realtime token1
  • GET/api/realtime/token
 Redaction rules5
  • GET/api/redaction_rules
  • POST/api/redaction_rules
  • GET/api/redaction_rules/{id}
  • PATCH/api/redaction_rules/{id}
  • and 1 more
 Retention policies5
  • GET/api/retention_policies
  • POST/api/retention_policies
  • GET/api/retention_policies/{id}
  • PATCH/api/retention_policies/{id}
  • and 1 more
 Roles5
  • GET/api/roles
  • POST/api/roles
  • GET/api/roles/{id}
  • PATCH/api/roles/{id}
  • and 1 more
 SLA policies5
  • GET/api/sla_policies
  • POST/api/sla_policies
  • GET/api/sla_policies/{id}
  • PATCH/api/sla_policies/{id}
  • and 1 more
 Support address5
  • GET/api/support_addresses
  • POST/api/support_addresses
  • GET/api/support_addresses/{id}
  • PATCH/api/support_addresses/{id}
  • and 1 more
 Suspended tickets4
  • GET/api/suspended_tickets
  • GET/api/suspended_tickets/{id}
  • DELETE/api/suspended_tickets/{id}
  • POST/api/suspended_tickets/{id}/recover
 Tags1
  • GET/api/tags
 Ticket audits1
  • GET/api/tickets/{ticketId}/audits
 Ticket comments1
  • GET/api/tickets/{ticketId}/comments
 Ticket fields4
  • GET/api/ticket_fields
  • POST/api/ticket_fields
  • GET/api/ticket_fields/{id}
  • PATCH/api/ticket_fields/{id}
 Ticket forms5
  • GET/api/ticket_forms
  • POST/api/ticket_forms
  • GET/api/ticket_forms/{id}
  • PATCH/api/ticket_forms/{id}
  • and 1 more
 Ticket layouts5
  • GET/api/ticket_layouts
  • POST/api/ticket_layouts
  • GET/api/ticket_layouts/{id}
  • PATCH/api/ticket_layouts/{id}
  • and 1 more
 Tickets4
  • GET/api/tickets
  • POST/api/tickets
  • GET/api/tickets/{id}
  • PATCH/api/tickets/{id}
 Trigger categories5
  • GET/api/trigger_categories
  • POST/api/trigger_categories
  • GET/api/trigger_categories/{id}
  • PATCH/api/trigger_categories/{id}
  • and 1 more
 Triggers5
  • GET/api/triggers
  • POST/api/triggers
  • GET/api/triggers/{id}
  • PATCH/api/triggers/{id}
  • and 1 more
 User fields5
  • GET/api/user_fields
  • POST/api/user_fields
  • GET/api/user_fields/{id}
  • PATCH/api/user_fields/{id}
  • and 1 more
 Users5
  • GET/api/me
  • GET/api/users
  • POST/api/users
  • GET/api/users/{id}
  • and 1 more
 Views5
  • GET/api/views
  • POST/api/views
  • GET/api/views/{id}
  • PATCH/api/views/{id}
  • and 1 more
 Webhook deliveries2
  • GET/api/webhook_deliveries
  • GET/api/webhook_deliveries/{id}
 Webhooks5
  • GET/api/webhooks
  • POST/api/webhooks
  • GET/api/webhooks/{id}
  • PATCH/api/webhooks/{id}
  • and 1 more