Deskbolic API Reference
Comprehensive REST API documentation, guides, and integration reference for Deskbolic.
Getting Started
Essential concepts, base URLs, authentication headers, rate limits, and error handling for Deskbolic API.
Authentication & Sessions
Endpoints for authenticating users, managing JWT sessions, password recovery, and mobile registration.
Identity & Profiles
Endpoints to retrieve authenticated user context, manage profile details, change passwords, and update agent availability.
Devices & Push Notifications
Endpoints to register and unregister mobile devices (iOS APNS / Android FCM) and web push tokens.
Inboxes
Endpoints to list and inspect omnichannel inboxes (Email, Web Widget, WhatsApp, Facebook, Instagram, API channels).
Customers (Contacts)
Endpoints to create, manage, search, and update customer profiles, addresses, and custom attributes.
Conversations
Core endpoints to list, create, assign, label, snooze, resolve, and manage omnichannel support conversations.
Messages
Endpoints to send omnichannel customer replies, post private team notes, list message history, and perform AI translations.
Attachments & Media
Endpoints to upload media files, images, documents, and generate direct S3 pre-signed upload URLs.
Agents & Teams
Endpoints to list workspace agents, view availability status, and manage team department assignments.
Labels & Tags
Endpoints to list and create workspace labels and color-coded tags for conversation classification.
Canned Responses
Endpoints to search and retrieve pre-written saved replies and macros for fast agent messaging.
Notifications & Settings
Endpoints to list user notifications, retrieve badge counts, mark as read, and update email/push notification preferences.
Custom Attributes
Endpoints to inspect dynamic custom field definitions for customers and conversations.
Search
Full-text search endpoints across conversations, message history, contacts, and custom filters.
System & Health
System health check, versioning metadata, ActionCable WebSocket endpoints, and platform feature flags.
User Guide
Customer help center, onboarding walkthroughs, feature guides, and tutorials.
Popular Articles
Need more help?
Contact Support
Avg. response: 2 hours