Tag Groups

Information

tag_groups are used to organize tags. You can use this resource type to request to see all the tags available for a particular tag_group: /catalog/v1/tag_groups/{TAG_GROUP_ID}?include=tags.

Below are tag_groups examples:

  • Cannabinoids
  • Effects
  • Flavors
  • Terpenes

API Requests

The request types and routes available for this resource as well as details on how to structure your requests are below. See API Reference - TagGroup for examples on how the requests might look in various languages and to test the requests in the browser.

RequestRouteDescription
GET/catalog/v1/tag_groupsRequest the information for all tag_groups
GET/catalog/v1/tag_groups/:idRequest the information for a particular tag_group

GET Index

To fetch all TagGroups, send a request to
/catalog/v1/tag_groups. By default, we only return the first 10 results from the request. You can adjust the number of returned results with page[size], or adjust the returned page with page[page].

Path

page[size] int32
Optional. Number of elements per page.


page[page] int32
Optional. Number of the page.


filter[is_category_group] string
Optional. Filters by whether a TagGroup is a Category Group or not. Set to true or false.


filter[name] string
Optional. Filters by TagGroup name.

GET Show

To fetch a TagGroup, send a request to
/catalog/v1/tag_groups/TAG_GROUP_ID.

Path

tag_group_id string
Required. TagGroup UUID you want to fetch.