Skip to content

Get collection​

GET
/collections/{collection_id}

Retrieves a single collection’s details by ID or slug.

Authorizations​

bearerToken|siteContext
bearerToken

Personal access token tied to a user account. Requires the X-Nimbu-Site header to scope requests.

TypeHTTP (bearer)
+
siteContext

Identifier of the site context when authenticating with a personal access token.

TypeAPI Key (header: X-Nimbu-Site)
or
siteToken

Site-scoped API token that already encodes the site context.

TypeHTTP (bearer)

Parameters​

Path Parameters

collection_id*

Collection identifier

Typestring
Required

Responses​

collection returned

application/json
JSON
{
"id": "string",
"url": "string",
"name": "string",
"slug": "string",
"fullpath": "string",
"description": "string",
"product_count": 0,
"status": "string",
"type": "string",
"priority": 0,
"seo_title": "string",
"seo_description": "string",
"seo_keywords": "string",
"images": [
{
"id": "string",
"position": 0,
"content_type": "string",
"width": 0,
"height": 0,
"size": 0,
"url": "string"
}
],
"featured_image": {
"id": "string",
"position": 0,
"content_type": "string",
"width": 0,
"height": 0,
"size": 0,
"url": "string"
},
"translations": {
"additionalProperties": {
}
},
"created_at": "string",
"updated_at": "string"
}

Playground​

Authorization
Variables
Key
Value

Samples​