List categories

get /api/categories

Retrieves the collection of Category resources.

Returns a paginated collection of categories in the current organization. Each carries its parent and childrens, so you can reconstruct the tree. Set Flowkiwi-Locale to read the translatable name in a given locale.

Headers

Name	Type	Required	Description
Flowkiwi-Locale	string	-	Specifies the locale for properties that support localization. If not provided, the default locale will be used.

Query parameters

Name	Type	Required	Description
expand	string	-	Comma-separated list of relations to embed as full objects instead of IRI strings. Supported values: parent (embeds the direct parent, max 1 level - grand-parents stay as IRIs), children (embeds direct children, max 1 level - grand-children stay as IRIs). Tokens are independent; unknown values are silently ignored.
page	integer	-	The collection page number
itemsPerPage	integer	-	The number of items per page
properties[]	string[]	-	Allows you to reduce the response to contain only the properties you need. If your desired property is nested, you can address it using nested arrays. Example: properties[]={propertyName}&properties[]={anotherPropertyName}&properties[{nestedPropertyParent}][]={nestedProperty}
id[]	string[]	-	Only the items with one of these ids, each a UUID or the item IRI.
status	string	-	Category status
status[]	string[]	-	Category status
name	string	-	Filter on the translated "name" field (case-insensitive partial match, uses the Flowkiwi-Locale header).
order[createdAt]	string	-	Category order[createdAt]
order[updatedAt]	string	-	Category order[updatedAt]

Response

200 - Category collection

Property	Type	Required	Description
search	object	-
Show search fields Property Type Required Description @type string - mapping object[] - Show mapping fields Property Type Required Description @type string - property string | null - required boolean - variable string - template string - variableRepresentation string -
totalItems	integer	-
view	object	-
Show view fields Property Type Required Description @id string - @type string - first string | null - last string | null - next string | null - previous string | null -
member	Category[]	required
Show member fields Property Type Required Description @context string | object - @id string required @type string required attributes string[] - The attribute definitions attached to this category. Requires the categories:read scope. Returned empty when the scope is missing. children array - A list of direct child Category, each one representing a category under this one. Serialized as IRI strings by default; pass ?expand=children to embed direct children (one level only). Requires the categories:read scope. Returned empty when the scope is missing. createdAt string - Creation date of the resource (ISO 8601 format). id string - The resource's unique identifier (UUID). name string | null - This property supports translations. The name of the category. parent string | Category | null - The parent Category to which this category belongs, if any. Serialized as IRI string by default; pass ?expand=parent to embed the direct parent (one level only). Requires the categories:read scope. Returned null when the scope is missing. products string[] - List of products associated with the category. Requires the products:read scope. Returned empty when the scope is missing. status "/api/statuses/DRAFT" | "/api/statuses/ACTIVE" | "/api/statuses/ARCHIVED" - The status of the category. updatedAt string - Last modification date of the resource (ISO 8601 format).

Errors

403 - Access denied. The caller is missing one or more permissions required for this operation.

Content-Type: application/problem+json

Property	Type	Required	Description
@context	string | object	-
@id	string	required
@type	string	required
detail	string	-
missingPermissions	string[]	-	Permissions that the caller is missing for this operation. Present only when the 403 is caused by a denied permission.
status	integer	-
title	string	-
type	string	-