Category API Reference

Endpoint:

https://[client].hiweb.io/api/categories

Category resource object:

{
	"type": "categories",
	"id": "(string)",
	"attributes": {
		"parent_id": "string|uuid",
		"title": "string",
		"handle": "string",
		"description": "string",
		"content": "string",
		"post_count": (integer),
		"created_at": "string|datetime",
		"updated_at": "string|datetime"
	},
	"relationships": {
		"image": {
			"data": Object (Image Resource) | null
		}
	}
}

Related resources: Image, Post

Writable fields

Field name	Creating	Updating
title	required|max:255	max:255
handle	max:255	max:255
description	max:255	max:255
content	max:60000	max:60000
parent_id	uuid	uuid

Writable relationships

Relationship name	Relationship resource type	Type	Creating	Updating
image	images	To-one	yes	yes

Filters

Filter name	Detail
ids	string, multiple ids accepted

Sortable

Field name
post_count
created_at
updated_at