Documentation › Public REST API

Public REST API

Prerequisites

To start using REST API you need to complete the following prerequisites:

  1. Create an API key

  2. Review the reference for the API you want to call, depending on the HelpDesk data center location:

Note

For more information about the data center location, please refer to the article.

How to use API

Our API is REST based. Thus, you can use any programming language that is able to execute web requests. For example, you would use C#, PowerShell, node.js, Python, PHP.

There are a lot of ready to use helper REST API clients for those languages. Here are just a few of them:

Curl and HTTP request examples

Here you can see a couple of examples of using HelpDesk REST API using curl command line tool or raw HTTP requests.

  1. Get tickets

  2. Create a ticket

  3. Delete a ticket

  4. Update a ticket

Get tickets

This is an example of a raw request to get tickets:

GET https://helpdesk-services.plumsail.com/_api/v4/Tickets?$select=SupportChannel&$filter=SupportChannel%20eq%20'API'&$orderBy=ID%20desc&$top=100 HTTP/1.1
Accept: application/json
X-HD-ApiKey: YOUR_API_KEY
Host: helpdesk-services.plumsail.com

And this is cURL representation for it:

curl -X GET --header 'Accept: application/json' --header 'X-HD-ApiKey: YOUR_API_KEY' 'https://helpdesk-services.plumsail.com/_api/v4/Tickets?$select=SupportChannel&$filter=SupportChannel%20eq%20'API'&$orderBy=ID%20desc&$top=100'

Create a ticket

This is an example of a raw request to create a ticket:

POST https://helpdesk-services.plumsail.com/_api/v4/Tickets HTTP/1.1
Accept: application/json
X-HD-ApiKey: YOUR_API_KEY
Content-Type: application/json

{
"subject": "Printer Issues",
"body": "My printer is not working. Please help. ASAP.",
"requesterEmail": "m.cane@example.com",
"priority": "High",
"tagTitles": [
    "Printers"
],
"attachments": [
    {
    "Name": "error.txt",
    "Content": "BASE64_FILE_CONTENT"
    }
],
"customFields": {}
}

And this is cURL representation for it:

curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' --header 'X-HD-ApiKey: YOUR_API_KEY' -d '{ \
"subject": "Printer Issues", \
"body": "My printer is not working. Please help. ASAP.", \
"requesterEmail": "m.cane%40example.com", \
"priority": "High", \
"tagTitles": [ \
    "Printers" \
], \
"attachments": [ \
    { \
    "Name": "error.txt", \
    "Content": "BASE64_FILE_CONTENT" \
    } \
], \
"customFields": {} \
}' 'https://helpdesk-services.plumsail.com/_api/v4/Tickets'

Delete a ticket

This is an example of a raw request to delete a ticket:

DELETE https://helpdesk-services.plumsail.com/_api/v4/Tickets/1 HTTP/1.1
X-HD-ApiKey: YOUR_API_KEY

And this is cURL representation for it:

curl -X DELETE --header 'X-HD-ApiKey: YOUR_API_KEY' 'https://helpdesk-services.plumsail.com/_api/v4/Tickets/1'

Update a ticket

This is an example of a raw request to update a ticket:

PUT https://helpdesk-services.plumsail.com/_api/v4/Tickets/18 HTTP/1.1
X-HD-ApiKey: YOUR_API_KEY
Accept: application/json
Content-Type: application/json

{
"assignedToEmail": "j.davis@example.com",
"status": "In progress",
"category": "Problem",
"priority": "Normal",
"dueDate": "2018-05-07",
"ccEmails": [
    "j.davis@example.com", "m.smith@example.com"
]
}

And this is cURL representation for it:

curl -X PUT --header 'Content-Type: application/json' --header 'Accept: application/json' --header 'X-HD-ApiKey: YOUR_API_KEY' -d '{ \
"assignedToEmail": "j.davis@example.com", \
"status": "In progress", \
"category": "Problem", \
"priority": "Normal", \
"dueDate": "2018-05-07", \
"ccEmails": [ \
    "j.davis%40example.com", "m.smith%40example.com" \
] \
}' 'https://helpdesk-services.plumsail.com/_api/v4/Tickets/18'