Skip to main content
GET
/
v1
/
collections
/
{id}
TypeScript SDK
import { Solifyn } from 'solifyn';

const solifyn = new Solifyn({ apiKey: 'your_private_api_key_here' });

// Retrieve details of a collection
const collection = await solifyn.collections.get('col_019e56a1...');
console.log('Collection Details:', collection);
{
  "id": "col_123",
  "name": "Summer Bundle",
  "status": "ACTIVE",
  "businessId": "biz_4r5t6y7u8i9o",
  "isPermanentlyDeleted": false,
  "createdAt": "2025-01-01T12:00:00Z",
  "updatedAt": "2025-01-01T12:00:00Z",
  "description": "Everything you need for summer.",
  "imageUrl": "https://example.com/image.png",
  "products": [
    {
      "id": "prod_9z8x7c6v5b4n",
      "name": "Enterprise SaaS Plan",
      "price": 99,
      "currency": "USD",
      "status": "ACTIVE",
      "imageUrl": "https://assets.solifyn.com/images/products/saas-enterprise.png",
      "taxCategory": "saas",
      "pricingType": "one_time",
      "discount": 0,
      "hasLicenseKey": true,
      "hasDigitalDelivery": false,
      "isTaxInclusive": false,
      "billingPeriod": null,
      "trialPeriodDays": null,
      "expirationDays": null,
      "statementDescriptor": "SOLIFYN*SAAS",
      "payWhatYouWant": false,
      "metadata": {
        "tier": "enterprise",
        "department": "engineering"
      },
      "customFields": [
        {
          "id": "57aa2241-eae4-43dc-b9ae-36069b84b2da",
          "name": "Discord Username",
          "order": 0,
          "required": true,
          "field_type": "text",
          "placeholder": "e.g. your_discord#1234"
        },
        {
          "id": "c86da32a-a967-457c-815b-c3440294d70b",
          "name": "Company Name",
          "order": 1,
          "required": false,
          "field_type": "text",
          "placeholder": "e.g. Acme Corp (Optional)"
        }
      ],
      "stock": null,
      "activationLimit": 5,
      "isListed": true,
      "isFree": false,
      "createdAt": "2026-05-18T12:00:00.000Z",
      "updatedAt": "2026-05-18T12:00:00.000Z",
      "isPermanentlyDeleted": false,
      "brandId": "brd_4e29285b8sdf34ff51e07d4",
      "digitalLink": null,
      "instructions": "Log in to your Solifyn developer dashboard and enter your license key to activate the premium SaaS resources.",
      "activationMessage": "Activation successful. Welcome to the Solifyn Enterprise Plan!",
      "expiryHours": 8760,
      "businessId": "biz_4r5t6y7u8i9o",
      "quantity": 1,
      "description": "Unlock premium API integration, custom webhooks, dedicated server bandwidth, and priority 24/7 business-critical support tiers."
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Authenticate requests using your standard bearer API key (e.g. YOUR_API_KEY).

Path Parameters

​
id
string
required

Collection ID

Example:

"col_123"

Response

200 - application/json

Collection details retrieved successfully.

​
id
string<uuid>
required

The collection ID

Example:

"col_123"

​
name
string
required

The name of the collection

Example:

"Summer Bundle"

​
status
enum<string>
required

Status of the collection

Available options:
ACTIVE,
ARCHIVED
Example:

"ACTIVE"

​
businessId
string
required

The unique identifier of the business owning this collection.

Example:

"biz_4r5t6y7u8i9o"

​
isPermanentlyDeleted
boolean
required

Indicates if the collection has been permanently deleted.

Example:

false

​
createdAt
string<date-time>
required

Timestamp when the collection was created

Example:

"2025-01-01T12:00:00Z"

​
updatedAt
string<date-time>
required

Timestamp when the collection was last updated

Example:

"2025-01-01T12:00:00Z"

​
description
string | null

A brief description of the collection

Example:

"Everything you need for summer."

​
imageUrl
string | null

URL of the collection image

Example:

"https://example.com/image.png"

​
products
object[]

Full product details including quantity for each item in the collection