Skip to main content

This helpcenter is releasing soon in the next release!

Search

Using the Libredesk API

Generate API keys for an agent and authenticate your requests.

You can drive your Libredesk instance programmatically by generating API keys for any agent. Some endpoints are not documented yet.

Generate API keys

1. Go to Admin, then Teammates, then Agents, and edit the agent you want the key for.

2. Generate a new API key. Libredesk shows an API key and an API secret for that agent.

3. Copy both and keep them somewhere safe. The secret is not shown again.

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

Authenticating

Libredesk accepts two authentication schemes.

Basic authentication, with the key and secret base64-encoded as key:secret:

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"

Endpoint reference

Every documented endpoint, with request and response examples, is in the API reference.

Was this article helpful?