Get Categories Endpoint

The Get Categories Endpoint allows Partners to retrieve Tixstock categories which are applicable to your feed settings.

This endpoint provides value if you need to output a Category listing or wish to obtain a top-level understanding of how the Events are categorised in your feed.

---

Endpoint URL

---

Authorisation	Description
Bearer Token	A valid bearer token must be provided within the header parameters for the API request. To generate an access token, please see your bearer token settings from within the Tixstock Partner Admin Area.

Please see 'Authentication - Bearer Tokens' for further information

---

Request Data

The supplied data must adhere to the following ruleset and passed as query parameters:

Query Parameters	Description
name	The name of the category. Type: String
parent	The name of the parent category. Type: String
order_by	Accepted Values: * name
sort_order	Accepted Values: asc / desc Type: String
per_page	Max: 50 Type: Integer
page	Type: Integer
has_listing	If set to true, will return only the categories that have listings on it Type: Boolean

---

API Response:

Please note the example shown below consists of dummy data for illustration purposes only

{
    "data": [
        {
            "id": "01g5nvm1m65an6r0tatqq81ama",
            "name": "Culture, Theatre & Arts",
            "upcoming_events": 0,
            "parent": [],
            "children": []
        },
        {
            "id": "01g5nvm1m65an6r0tatqq81ama",
            "name": "Festivals",
            "upcoming_events": 0,
            "parent": [],
            "children": []
        },
        {
            "id": "01g5nvm1m65an6r0tatqq81ama",
            "name": "Music",
            "upcoming_events": 0,
            "parent": [],
            "children": []
        },
        {
            "id": "01g5nvm1m65an6r0tatqq81ama",
            "name": "Sport",
            "upcoming_events": 895,
            "parent": [],
            "children": [
                {
                    "id": "01g5nvm1m65an6r0tatqq81ama",
                    "name": "Football",
                    "upcoming_events": 907,
                    "children": [
                        {
                            "id": "01g5nvm1m65an6r0tatqq81ama",
                            "name": "Serie A",
                            "upcoming_events": 270,
                            "children": []
                        },
                        {
                            "id": "01g5nvm1m65an6r0tatqq81ama",
                            "name": "UEFA Nations League",
                            "upcoming_events": 2,
                            "children": []
                        },
                        {
                            "id": "01g5nvm1m65an6r0tatqq81ama",
                            "name": "Russian Premier League",
                            "upcoming_events": 2,
                            "children": []
                        },
                        {
                            "id": "01g5nvm1m65an6r0tatqq81ama",
                            "name": "Ligue 1",
                            "upcoming_events": 208,
                            "children": []
                        },
                        {
                            "id": "01g5nvm1m65an6r0tatqq81ama",
                            "name": "Scottish Premiership",
                            "upcoming_events": 26,
                            "children": []
                        },
                        {
                            "id": "01g5nvm1m65an6r0tatqq81ama",
                            "name": "Champions League",
                            "upcoming_events": 58,
                            "children": []
                        }
                    ]
                }
            ]
        }
    ],
    "meta": {
        "mode": "",
        "type": "partner.categories.get",
        "current_page": 1,
        "from": 1,
        "path": "https://pf.tixstock.com/v1\/categories/feed",
        "per_page": 10,
        "to": 1,
        "request_id": "01eg13cw13473tagfvrxscpmbd"
    },
    "links": {
        "self": "link-value",
        "first": "https://pf.tixstock.com/v1\/categories/feed?page=1",
        "last": null,
        "prev": null,
        "next": null
    }
}

---