Skip to main content

Try the live demo!

Search

API Introduction

Getting started with the libredesk API

Generate an API key for any agent to work with your instance through the libredesk API.

Note:

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 → Teammates → Agents and open the agent.
  2. Click Generate API key.
  3. Copy both the API key and the API secret. The secret is shown only once.

Base URL

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

Response format

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

OpenAPI specification

Download the complete OpenAPI specification.

Was this article helpful?