API Introduction

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.

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

Responses are JSON. A successful response wraps the result in data. An error response has a message and an error_type.