List Categories
/categories/list
List all categories in alphabetical order. Note that a parent_id will not be supplied for top-level categories.
Response
<categories>
[…]
<category id="1" slug="arts">
Performing Arts
</category>
<category id="240" slug="industry-events-pharmaceuticals" parent_id="91">
Pharmaceuticals
</category>
<category id="150" slug="pop-gigs" parent_id="6">
Pop
</category>
[…]
<categories>
Top Level List of Categories
/categories/topLevelList
List all top-level categories in alphabetical order. Note that a parent_id will not be supplied for any of these categories.
Response
<categories>
[…]
<category id="2" slug="community">Family & Community</category>
<category id="190" slug="lifestyle">Festivals & Lifestyle</category>
<category id="1" slug="arts">Performing Arts</category>
[…]
<categories>
Get Category by ID
/categories/get/id/{$id}
Return the category specified by the numeric ID {$id}.
Request
/categories/get/id/150
Response
<category id="150" slug="pop-gigs" parent_id="6">Pop</category>
Get Category by Slug
/categories/get/slug/{$slug}
Return the category specified by the alphanumeric URL Slug {$slug}.
Request
/categories/get/slug/pop-gigs
Response
<category id="150" slug="pop-gigs" parent_id="6">Pop</category>
List Child Categories
/categories/getChildren/id/{$id}
Return the sub-categories/genres (if any) of the category specified by the numeric ID {$id}. Results will be ordered alphanumerically.
Request
/categories/getChildren/id/1
Response
<categories>
[…]
<category id="22" slug="dance" parent_id="1" count="23">Dance</category>
<category id="56" slug="fashion" parent_id="1" count="12">Fashion</category>
<category id="25" slug="film" parent_id="1" count="17">Film</category>
[…]
</categories>
This response includes the number of active events in each category (the "count"). The count also includes events in sub-categories of each category. By default, the count shown is for upcoming events in the whole of New Zealand. You can change this behaviour using the following optional parameters, for example, to show accurate counts for just events in Waikato next month.
location |
Only count events that are in the location specified by this ID, or its child locations. |
start_date |
Only count events that are on or after this date (format YYYY-MM-DD). |
end_date |
Only count events that are on or before this date (format YYYY-MM-DD). |
Get Parent Category
/categories/getParent/id/{$id}
Returns the parent category (if applicable) for the category specified by the numeric ID {$id}.
Request
/categories/getParent/id/22
Response
<category id="1" name="Performing Arts" slug="arts" parent_id="246"/>