The Libredesk API allows you to interact with your instance programmatically.

​
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

All API responses are returned in JSON format.