Quickstart

This guide walks you through creating your first API request against the Helpdesk API.

Prerequisites

• An Airclou account with Helpdesk enabled
• An API key (create one in Settings > API Keys)
• Your workspace ID (visible in Settings > General or in the URL)

Create a ticket

curl -X POST https://app.airclou.com/helpdesk/api/v1/tickets \
  -H "Authorization: Bearer aclou_YOUR_API_KEY" \
  -H "X-Workspace-Id: ws_your_workspace_id" \
  -H "Content-Type: application/json" \
  -d '{
    "ticket": {
      "subject": "Cannot log in",
      "description": "User reports login failure after password reset.",
      "priority": "high"
    }
  }'

The response contains the newly created ticket object:

{
  "ticket": {
    "id": "tkt_abc123",
    "subject": "Cannot log in",
    "status": "new",
    "priority": "high",
    "type": "question",
    "customFields": [],
    "createdAt": "2025-01-15T10:30:00.000Z",
    "updatedAt": "2025-01-15T10:30:00.000Z"
  }
}

List your tickets

curl https://app.airclou.com/helpdesk/api/v1/tickets \
  -H "Authorization: Bearer aclou_YOUR_API_KEY" \
  -H "X-Workspace-Id: ws_your_workspace_id"

Next steps

• Authentication — learn about API key permissions and required headers
• Tickets — full CRUD reference for the Tickets resource
• Ticket Fields — manage custom fields and their options
• Webhooks — subscribe to real-time events
• Errors — understand error codes and rate limits