HelpDesk API (1.0.0)

Download OpenAPI specification:Download

Introduction

This document describes public API of HelpDesk Product

Authentication

HelpDesk API shares authentication and authorization system with LiveChat. More details can be found in Authorization Documentation.

Endpoints require Authorization HTTP header. Authorization methods include:

  • Personal Access Tokens (good for testing and development pruposes). PATs can be created using Developers Console in Tools / Personal Access Tokens section. Please use your HelpDesk credentials to log into the console. Please use accounts--my:ro scope to generate the token. After generating token, use Basic authentication scheme with account_id displayed in Developers Console as user name and generated token as a password. Detailed instructions.
  • OAuth 2 Authorization Code Grant flow (recommended for production deployment) - details of implementation are described in Authorization code grant documentation.
  • Other possible options are described in Use cases documentation section.

Common notions

Relative dates and date/time ranges

All date/time ranges are half-open i.e. [from, to)

In addition to absolute timestamps/dates, it is possible to specify relative dates in format: [-+][number][hHdDM]. Sign (+ or -) denotes relation to current timestamp, number denotes amount of unit, and unit represent minutes (n), hours (h), days (d) and months (m). Lowercase units are relative to current timestamp and uppercase units are relative to start of current truncated period. Examples:

Relative date Description
-2d 48 hours before now
+1m 1 month from now in the future
-0M start of current month
-1M start of last month
-0D last midnight
-10n 10 minutes before now

Gotchas

User-Agent header

We advise to always include User-Agent header in API requests. Requests missing it might be blocked by intermediary services.

Licenses

License describes a customer account. Contains:

  • subscription information (selected plan, number of agent slots)
  • global license settings
  • default team designation. Default team is selected among all teams and serve as a default/fallback mechanism every place team can not be determined or hasn't been specified

List licenses

Returns list of licenses. Normally it contains only one element.

Responses

Response Schema: application/json
Array ()
ID
integer

Unique account identifier

createdAt
string

Time of creation

createdBy
string

Creator identifier

createdByType
string
Enum: "agent" "client" "system"

Creator type

updatedAt
string

Time of last modification

updatedBy
string

Modification author identifier

defaultTeamID
string

Default team

object
object
object