{
"description": "A list of categorisations",
"type": "object",
"properties": {
"count": {
"description": "The number of categorisations returned",
"type": "integer",
"readOnly": true
},
"items": {
"type": "array",
"items": {
"description": "The response body containing the information for a categorisation",
"properties": {
"categorisation": {
"properties": {
"categories": {
"type": "array",
"items": {
"description": "The response body containing the information for a category",
"properties": {
"id": {
"type": "string"
},
"label": {
"type": "string"
}
}
}
},
"default_categorisation": {
"type": "boolean"
},
"id": {
"type": "string"
},
"label": {
"type": "string"
},
"total_count": {
"type": "integer"
}
}
}
}
}
},
"limit": {
"description": "The number of categorisations requested",
"type": "integer"
},
"offset": {
"description": "The first row of categorisations to retrieve, starting at 0. Use this parameter as a pagination mechanism along with the limit parameter",
"type": "integer"
},
"total_count": {
"description": "The total number of categorisations",
"type": "integer",
"readOnly": true
}
}
}
{
"description": "The response body containing an error message",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "string"
}
}
}
}