API Getting Started

Access the Libredesk API to interact with your instance programmatically

You can access the Libredesk API to interact with your instance programmatically by generating API keys for any agent.

Some endpoints are not documented yet. Pull requests to the docs are welcome.

Generating API keys

1. Edit agent

   Go to Admin → Teammate → Agent → Edit

2. Generate new API key

   Libredesk shows an API key and an API secret for that agent

3. Save the credentials

   Keep both the API key and API secret secure

4. Key management

   You can revoke or regenerate API keys at any time from the same page

Using the API

Libredesk supports two authentication schemes:

Basic authentication

curl -X GET "https://your-libredesk-instance.com/api/endpoint" \
  -H "Authorization: Basic <base64_encoded_key:secret>"

Token authentication

curl -X GET "https://your-libredesk-instance.com/api/endpoint" \
  -H "Authorization: token your_api_key:your_api_secret"

API reference

Every documented endpoint is listed in the API reference.

View API reference

Browse endpoints with request and response examples