List collections

get /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 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`	-	Collection status
`status[]`	`string[]`	-	Collection status
`exists[parent]`	`boolean`	-	Collection exists[parent]
`name`	`string`	-	Filter on the translated "name" field (case-insensitive partial match, uses the Flowkiwi-Locale header).
`order[name]`	`string`	-	Order by translated field "name" (uses the Flowkiwi-Locale header)
`productsCount`	`integer`	-	Filter by the exact number of related "products".
`productsCount[gte]`	`integer`	-	Filter by the number of related "products" (gte).
`productsCount[gt]`	`integer`	-	Filter by the number of related "products" (gt).
`productsCount[lte]`	`integer`	-	Filter by the number of related "products" (lte).
`productsCount[lt]`	`integer`	-	Filter by the number of related "products" (lt).
`childrenCount`	`integer`	-	Filter by the exact number of related "children".
`childrenCount[gte]`	`integer`	-	Filter by the number of related "children" (gte).
`childrenCount[gt]`	`integer`	-	Filter by the number of related "children" (gt).
`childrenCount[lte]`	`integer`	-	Filter by the number of related "children" (lte).
`childrenCount[lt]`	`integer`	-	Filter by the number of related "children" (lt).
`order[createdAt]`	`string`	-	Collection order[createdAt]
`order[updatedAt]`	`string`	-	Collection order[updatedAt]

Response

200 - Collection collection

Format

Property Type Required Description

search object -

Show search fields

Property Type Required Description

@type string -

mapping object[] -

Show mapping fields

Property	Type	Required
`@type`	`string`	-
`property`	`string \| null`	-
`required`	`boolean`	-
`variable`	`string`	-

template string -

variableRepresentation string -

totalItems integer -

view object -

Show view fields

Property	Type	Required
`@id`	`string`	-
`@type`	`string`	-
`first`	`string \| null`	-
`last`	`string \| null`	-
`next`	`string \| null`	-
`previous`	`string \| null`	-

member Collection[] required

Show member fields

Property	Type	Required	Description
`@context`	`string \| object`	-
`@id`	`string`	required
`@type`	`string`	required
`childrens`	`array`	-	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). Requires the `collections:read` scope. Returned empty when the scope is missing.
`createdAt`	`string`	-	The date and time when the resource was created (ISO 8601 format).
`id`	`string`	-	The resource's unique identifier (UUID).
`name`	`string \| null`	-	This property supports translations. The display name of the collection.
`parent`	`string \| Collection \| 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). Filter with `?exists[parent]=false` to list root collections (no parent) or `?exists[parent]=true` for nested ones. Requires the `collections:read` scope. Returned null when the scope is missing.
`products`	`string[]`	-	A list of `Product` IRIs the collection groups together. 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 collection.
`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 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`	-