API Getting Started

Generate an API key for any agent to work with your instance through the libredesk API.

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

Generating API keys

You need the users:manage permission to generate API keys.

Open the agent

Go to Admin → Teammates → Agents and open the agent.

Generate an API key

Click Generate API key. libredesk shows an API key and an API secret for that agent.

Save the credentials

Copy both values and store them securely. The secret is shown only once.

Key management

Regenerate or revoke the key at any time from the same page.

A request made with an API key has the same roles and permissions as the agent that owns the key.

All endpoints are under /api/v1. libredesk supports two authentication schemes:

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

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

Every documented endpoint is listed in the API reference.

Browse endpoints with request and response examples