Version: 202506
Get collection
GET/openapi/2025-06/collections/:id
Retrieves detailed information about a specific collection by providing its unique identifier.
Request
Path Parameters
id stringrequired
Collection ID. Must be a valid UUID
Responses
- 200
OK
- application/json
- Schema
- Example
Schema
codestring
error code
messagestring
error message
data object
collection object
Collection
idstring
Collection ID
titlestring
Title
descriptionstring
Description
handlestring
URL-friendly identifier (handle)
smartboolean
Smart
image object
Image
srcstring
Image source URL
widthint32
Width dimension
heightint32
Height dimension
altstring
Alt text for image
seo_titlestring
SEO title
seo_keywordsstring[]
SEO keywords
seo_descriptionstring
SEO description
sort_orderstring
Sort order
created_atstring
Creation timestamp, in ISO-8601 format
updated_atstring
Last update timestamp, in ISO-8601 format
{
"code": "string",
"message": "string",
"data": {
"collection": {
"id": "string",
"title": "string",
"description": "string",
"handle": "string",
"smart": true,
"image": {
"src": "string",
"width": 0,
"height": 0,
"alt": "string"
},
"seo_title": "string",
"seo_keywords": [
"string"
],
"seo_description": "string",
"sort_order": "string",
"created_at": "string",
"updated_at": "string"
}
}
}