List collections

get /rest/api/collections

Retrieves the collection of Collection resources.

Returns a paginated collection of collections in the current organization. Pass expand to embed related resources, and set X-Flowkiwi-Locale to read the translatable name in a given locale.

Headers

Name	Type	Required	Description
X-Flowkiwi-Organization-Id	string	required	The organization the request acts as. Determines the identity, permissions and ownership applied when reading or modifying data on the instance.
X-Flowkiwi-Locale	string	-	Specifies the locale for properties that support localization. If not provided, the default locale will be used.
X-Flowkiwi-Locale-Fallback	boolean	-	Enables the use of a fallback locale. If a property lacks a translation for the requested locale, the value from 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
order[createdAt]	string	-
order[updatedAt]	string	-

Response

200 - Collection collection

Property	Type	Required	Description
hydra:totalItems	integer	-
hydra:search	object	-
Show hydra:search fields Property Type Required Description @type string - hydra:template string - hydra:variableRepresentation string - hydra:mapping object[] - Show hydra:mapping fields Property Type Required Description @type string - variable string - property string | null - required boolean -
hydra:view	object	-
Show hydra:view fields Property Type Required Description @id string - @type string - hydra:first string - hydra:last string - hydra:previous string - hydra:next string -
hydra:member	Collection[]	required
Show hydra:member fields Property Type Required Description @context object - @id string required @type string required id string - The resource's unique identifier (UUID). status string - The status of the collection. name string | null - This property supports translations. The display name of the collection. parent string | null - The parent Collection to which this collection belongs, if any. Serialized as IRI string by default; pass ?expand=parent to embed the direct parent (one level only). products string[] - A list of Product IRIs the collection groups together. childrens string[] - A list of direct child Collection IRIs nested under this collection. Serialized as IRI strings by default; pass ?expand=children to embed direct children (one level only). createdAt string - The date and time when the resource was created (ISO 8601 format). updatedAt string - The date and time when the resource was last modified (ISO 8601 format).

Errors

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

Content-Type: application/problem+json

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