List attribute definitions

get /api/attribute_definitions

Retrieves the collection of AttributeDefinition resources.

Returns a paginated collection of attribute definitions. Filter by type, code or id[], search the translated name (case-insensitive partial match in the Flowkiwi-Locale locale), and sort by order[createdAt] or order[updatedAt]. This endpoint is only available in the unstable version.

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
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.
type	string	-	AttributeDefinition type
type[]	string[]	-	AttributeDefinition type
code	string	-	AttributeDefinition code
code[]	string[]	-	AttributeDefinition code
name	string	-	Filter on the translated "name" field (case-insensitive partial match, uses the Flowkiwi-Locale header).
order[createdAt]	string	-	AttributeDefinition order[createdAt]
order[updatedAt]	string	-	AttributeDefinition order[updatedAt]

Response

200 - AttributeDefinition 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	AttributeDefinition[]	required
Show member fields Property Type Required Description @context string | object - @id string required @type string required categories string[] - The categories this attribute definition is attached to. Requires the categories:read scope. Returned empty when the scope is missing. code string | null - The stable, machine-readable identifier of the attribute definition (e.g. color, care-instructions). Immutable once created. createdAt string - Creation date of the resource (ISO 8601 format). id string - multiple boolean - Whether products may carry several values for this definition (one per option). Meaningful for list definitions only; always false for string definitions regardless of the requested value. Immutable once created. name string | null - This property supports translations. The human-readable name of the attribute definition. type "string" | "list" | null - The type of the attribute definition, determining whether its values are free text (string) or must come from a fixed set of options (list). Immutable once created. updatedAt string - Last modification date of the resource (ISO 8601 format). valuesCount integer - The count of the product attribute values that reference this definition.

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	-