HelpDesk API (1.0.0)
Download OpenAPI specification:Download
This document describes public API of HelpDesk Product
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.
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 |
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
| 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 |
Response samples
- 200
[- {
- "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": {
- "defaultInboxUsed": false
}