Skip to main content



For more technical details, see our API Reference

Defining categories#

Category labels are defined manually by the customer during onboarding.

Reading categories#

You can view the labels of categories set for you by issuing a GET request to /categories. This will return a few fields, including a heron_id which is a unique identifier generated by Heron Data for the category.

curl --location --request GET '' \
--header '<your-authorisation>'

Responses are of the form:

"categories": [
"label": "some_category",
"created": "2020-11-23T17:46:56+00:00",
"description": "some optional description",
"heron_id": "ctg_nF5uQxLPBJn5RErH8QGeTH"