API Introduction

Getting started with the Libredesk API

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.

Authentication

The API supports two authentication methods:

Basic authentication

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

Token authentication

curl -X GET "https://your-instance.com/api/v1/endpoint" \
  -H "Authorization: token api_key:api_secret"

Getting API keys

1. Go to Admin → Teammate → Agent → Edit
2. Generate a new API key
3. Save both the API Key and API Secret

Base URL

https://your-instance.com/api/v1

Response format

Every response is JSON.