API Introduction

Deskpro Developer Starter

Search…

Introduction

Embeddables

API Basics

Getting Started with the API

PHP

JavaScript

API Introduction

The Deskpro API is a REST API that runs over HTTP(S). All API requests are made to a URL that begins with http://example.com/api/v2/.
The API uses JSON for requests and responses. There are a few exceptions to this rule where an API is explicitly designed to return a specific kind of resource. Those will be noted within the documentation.
Here’s an example call made to the helpdesk/discover endpoint:
1
curl http://example.com/api/v2/helpdesk/discover
Copied!
The response will look something like this:
1
{
2
    "data": {
3
        "is_deskpro": true,
4
        "helpdesk_url": "https:\/\/example.com\/",
5
        "base_api_url": "https:\/\/example.com\/api\/v2\/",
6
        "build": "1477995658"
7
    },
8
    "meta": {},
9
    "linked": {}
10
}
Copied!

Embeddables - Previous

Form Embed

Next - API Basics

Auth

Last modified 3yr ago

Copy link