API Introduction

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

If you come across API calls that are yet to be documented, Please consider contributing to docs.

Authentication

The API supports two authentication methods:

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

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

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

All API responses are returned in JSON format.