Get one by key

Returns one category resolved from its unique_key, which is trimmed and lowercased before the lookup; otherwise identical to fetching it by id.

GET /api/{tenant:minlength(2)}/v{version:apiVersion}/categories/key/{unique_key}

Request arguments

Name	Type	Source
unique_key	String

Request body example

Response body example

Name	Type	ReadOnly	Description
created_by	DTO_reference_user	ReadOnly	Created by
last_updated_by	DTO_reference_user	ReadOnly	Last updated by
children	DTO_category[]	ReadOnly	Children
id	Int32	ReadOnly	Leave empty when Creating object
parent_id	Int32		Parent id
name	String		Name
name_path	String[]	ReadOnly	Name path
unique_key	String		Unique key
description	String		Description
visibility	ENUM category_visibility		Visibility
icon_id	Int32		Icon id
icon_file	String	ReadOnly	Icon file
created	DateTime	ReadOnly	Created
last_updated	DateTime	ReadOnly	Last updated

Name	Type	ReadOnly	Description
profile_pic	String	ReadOnly	Profile pic
email	String	ReadOnly	Email
id	Int32		Id
label	Object	ReadOnly	Label

Name	Type	ReadOnly	Description
created_by	DTO_reference_user	ReadOnly	Created by
last_updated_by	DTO_reference_user	ReadOnly	Last updated by
children	DTO_category[]	ReadOnly	Children
id	Int32	ReadOnly	Leave empty when Creating object
parent_id	Int32		Parent id
name	String		Name
name_path	String[]	ReadOnly	Name path
unique_key	String		Unique key
description	String		Description
visibility	ENUM category_visibility		Visibility
icon_id	Int32		Icon id
icon_file	String	ReadOnly	Icon file
created	DateTime	ReadOnly	Created
last_updated	DateTime	ReadOnly	Last updated

Generated Aug 4, 2026 18:37