HelpDesk logo
Documentation Powered by ReDoc

HelpDesk API (1.0.0)

Download OpenAPI specification:Download

E-mail: support@helpdesk.com URL: https://www.helpdesk.com

Introduction

This document describes public API of HelpDesk Product

Authentication

API endpoints are using bearer tokens to authenticate. Each endpoint requires Authorization: Bearer ACCESS_TOKEN HTTP header. For test purposes, token extracted from regular app requests in the browser can be used. To acquire permanent API access for your HelpDesk account, please contact us at support@helpdesk.com.

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 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

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

200

A JSON Array of licenses

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

flags
object
settings
object
source
object
get/v1/licenses
https://api.helpdesk.com/v1/licenses
https://api.labs.helpdesk.com/v1/licenses

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Create license

Creates new license object. Only required during first app login after account in HelpDesk Accounts has been created.

Request Body schema: application/json
planCode
required
string
Enum: "hd-starter1m" "hd-starter12m" "hd-team1m" "hd-team12m" "hd-team36m"
couponCode
string
source
object

Responses

200

created agent

Response Schema: application/json
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

flags
object
settings
object
source
object
post/v1/licenses
https://api.helpdesk.com/v1/licenses
https://api.labs.helpdesk.com/v1/licenses

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "planCode": "hd-starter1m",
  • "couponCode": "string",
  • "source":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "ID": 13381337,
  • "createdAt": "2020-04-30T22:02:08.901Z",
  • "createdBy": "f56caf69-3f05-4386-9567-fdc909d7ad77",
  • "createdByType": "agent",
  • "updatedAt": "2020-04-30T22:02:08.901Z",
  • "updatedBy": "f56caf69-3f05-4386-9567-fdc909d7ad77",
  • "defaultTeamID": "f56caf69-3f05-4386-9567-fdc909d7ad77",
  • "flags":
    {
    },
  • "settings":
    {
    },
  • "source":
    {
    }
}

Get license

Returns license data by licenseID.

path Parameters
licenseID
required
string

Responses

200

JSON of license

Response Schema: application/json
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

flags
object
settings
object
source
object
get/v1/licenses/{licenseID}
https://api.helpdesk.com/v1/licenses/{licenseID}
https://api.labs.helpdesk.com/v1/licenses/{licenseID}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "ID": 13381337,
  • "createdAt": "2020-04-30T22:02:08.901Z",
  • "createdBy": "f56caf69-3f05-4386-9567-fdc909d7ad77",
  • "createdByType": "agent",
  • "updatedAt": "2020-04-30T22:02:08.901Z",
  • "updatedBy": "f56caf69-3f05-4386-9567-fdc909d7ad77",
  • "defaultTeamID": "f56caf69-3f05-4386-9567-fdc909d7ad77",
  • "flags":
    {
    },
  • "settings":
    {
    },
  • "source":
    {