help

GET /api/3.0/help

Retrieve a list of API endpoints.

Public API

If the Public API is enabled, unauthenticated users can make requests to the /help endpoint. Both the public and authenticated responses are identical.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
{
    "version": "3.0",
    "account_id": 1,
    "host_id": "your-company.checkfront.com",
    "name": "Your Company",
    "locale": {
        "id": "en_US",
        "lang": "en",
        "currency": "CAD"
    },
    "request": {
        "status": "OK",
        "resource": "help",
        "records": 13,
        "limit": 0,
        "page": 1,
        "pages": 1,
        "time": 0.001,
        "method": "get"
    },
    "help": {
        "resources": [
            "ping",
            "help",
            "company",
            "account",
            "customer",
            "item",
            "stock",
            "category",
            "booking",
            "discount",
            "event",
            "giftcert",
            "inventory"
        ],
        "see": "http://api.checkfront.com/"
    }
}