category

GET /api/3.0/category

Retrieve a list of the available categories in the system.

Response JSON Array of Objects:
 
  • category_id (integer) – The unique ID of the category.
  • name (string) – The display name of the category.
  • pos (integer) – The order in which the category will display.

Public API

If the Public API is enabled, unauthenticated users can make requests to the /category endpoint. This is the same functionality as a customer viewing the categories on the Customer Booking Page. Only categories that are publicly visible and have customer-visible items will be returned. Check out our Knowledge Base for more information on how Categories display on the Booking Page.

 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
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
{
    "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": "category",
        "records": 6,
        "limit": 0,
        "page": 1,
        "pages": 1,
        "time": 0.0028,
        "method": "get"
    },
    "query": [],
    "category": {
        "2": {
            "category_id": 2,
            "name": "Tours",
            "description": "From Walking, to Bicycles, to Double Decker buses, we have the perfect tour for you and your family.",
            "pos": 20,
            "image": "/media/Lcat-2.jpg",
            "image_url": "https://storage.googleapis.com/cf-public-us/thelondonexperience-67672/media/Lcat-2?t=1522874544771961",
            "qty": 5
        },
        "4": {
            "category_id": 4,
            "name": "Accommodations",
            "description": "Book a Double or Single room for your overnight stay in Manchester.",
            "pos": 17,
            "image": "/media/Lcat-4.jpg",
            "image_url": "https://storage.googleapis.com/cf-public-us/thelondonexperience-67672/media/Lcat-4?t=1522874547513165",
            "qty": 4
        },
        "5": {
            "category_id": 5,
            "name": "Gift Certificates",
            "description": "Give the Gift of The London Experience.",
            "pos": 16,
            "image": "/media/Lcat-5.jpg",
            "image_url": "https://storage.googleapis.com/cf-public-us/thelondonexperience-67672/media/Lcat-5?t=1522874548913993",
            "qty": 4
        },
        "6": {
            "category_id": 6,
            "name": "Activities",
            "description": "",
            "pos": 19,
            "image": "/media/Lcat-6.jpg",
            "image_url": "https://storage.googleapis.com/cf-public-us/thelondonexperience-67672/media/Lcat-6?t=1522874550706040",
            "qty": 3
        },
        "7": {
            "category_id": 7,
            "name": "Merchandise",
            "description": "",
            "pos": 14,
            "image": "/media/Lcat-7.jpg",
            "image_url": "https://storage.googleapis.com/cf-public-us/thelondonexperience-67672/media/Lcat-7?t=1522874552392653",
            "qty": 3
        }
    }
}