Skip to main content

API Reference Demo GitHub

en
es

↑↓ Navigate ↵ Select esc Close

Introduction

Getting started

Installation
Deploy on Railway
Upgrade Guide
API Getting Started

Connecting Inboxes
Live Chat
WhatsApp
Help Center
Email Templates
AI
SSO Setup
Webhooks
Context Links
SSRF protection

Roles and permissions

Roles & Permissions

Developer Setup
Translations

API Introduction
Widget API

Get all Conversations
Create Conversation
Get Conversation
Get Messages
Get Message
Download Conversation Transcript
Send Message
Retry Message
Get Assigned Conversations
Get Unassigned Conversations
Get Team Unassigned Conversations
Get View Conversations
Get Conversation Participants
Update Conversation Status
Update Conversation Priority
Update User Assignee
Update Team Assignee
Remove User Assignee
Remove Team Assignee
Update Conversation Assignee Last Seen
Update Conversation Custom Attributes
Update Contact Custom Attributes
Update conversation tags

Conversation Status and Priority

Get Conversation Statuses
Create Conversation Status
Update Conversation Status
Delete Conversation Status
Get Conversation Priorities

Get Contacts
Get Contact
Update Contact
Block or Unblock Contact
Delete Contact
Export Contact Data
Get Contact Notes
Create Contact Note
Delete Contact Note

Agents and Teams

Get Agents
Get Agent
Create Agent
Update Agent
Delete Agent
Get Current Agent
Update Current Agent Availability
Generate API Key
Revoke API Key
Get Teams
Create Team
Get Team
Update Team
Delete Team

AI Completion
Get AI Prompts
Update AI Provider

Health Check

Search Conversations
Search Contacts
Search Messages

Media Upload
Serve Media

List Tags
Create Tag
Update Tag
Delete Tag

Custom Attributes

List Custom Attributes

List Inboxes

Get Overview Counts
Get Overview Charts
Get Overview CSAT
Get Overview Message Volume
Get Overview SLA
Get Overview Tag Distribution

Get Public Help Center Tree
Get Public Help Center Article
Search Public Help Center

Libredesk
Contributing

Contributing

Set up a development environment and help translate libredesk.

Developer Setup
Translations

Libredesk is open-source customer support software you host yourself.

API Reference Website Demo

Powered by libredesk