Retrieve a collection

get /api/collections/{id}

Retrieves a Collection resource.

Returns a single collection by id, including its parent, child collections and the products it groups. Pass expand to embed related resources instead of returning them as IRIs.

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
id	string	required	Collection identifier

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.
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}

Response

200 - Collection resource

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	-

404 - Not found

Property	Type	Required	Description
@context	string | object	-
@id	string	required
@type	string	required
code	string	-	Stable identifier of the error in the error code catalogue (see /api/error-codes). Present on catalogued errors only.
description	string | null	-
detail	string | null	-	A human-readable explanation specific to this occurrence of the problem.
instance	string | null	-	A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
message	string	-	End-user message localized in the request locale, with this occurrence's values substituted. Present on catalogued errors only.
slug	string	-	Stable, readable key of the error in the error code catalogue. Present on catalogued errors only.
status	integer | null	-
title	string | null	-	A short, human-readable summary of the problem. For a catalogued error it repeats the slug.
type	string	-	A URI reference that identifies the problem type. For a catalogued error it is the error code resource, /api/error-codes/{code}.