List attribute options

get /api/attribute_definitions/{definitionId}/options

Retrieves the collection of AttributeOption resources.

Returns a paginated collection of the options of one attribute definition, identified by definitionId. Sort by order[position] to get them in display order, and set Flowkiwi-Locale to read the translatable value in a given locale. 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.

Path parameters

Name	Type	Required	Description
definitionId	string	required	AttributeDefinitionResource identifier

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.
order[position]	string	-	AttributeOption order[position]
order[createdAt]	string	-	AttributeOption order[createdAt]
order[updatedAt]	string	-	AttributeOption order[updatedAt]

Response

200 - AttributeOption 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	AttributeOption[]	required
Show member fields Property Type Required Description @context string | object - @id string required @type string required createdAt string - Creation date of the resource (ISO 8601 format). definition string | null - The attribute definition this option belongs to. Requires the categories:read scope. Returned null when the scope is missing. id string - position integer | null - The display position of the option within its definition, used for ordering. Omit on creation to append the option at the end. updatedAt string - Last modification date of the resource (ISO 8601 format). value string | null - This property supports translations. The value of the option.

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	-