Get Categories Endpoint

The get categories endpoint will allow resellers to retrieve all category information held in the Tixstock system.

Endpoint URL

https://api.tixstock.com/v1/categories/get

Authorisation

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 API settings from within the Tixstock Reseller 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 Category Name.

Type: String
order_by Accepted Values:
* name
sort_order Accepted Values: asc / desc
Type: String
per_page Max: 50
Type: Integer
page Type: Integer

API Response:

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

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