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