Skip to main content
GET
/
api
/
collections
List collections (seasonal / merchandising groupings)
curl --request GET \
  --url https://app.solya.app/api/collections \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "code": "SS26",
      "createdAt": "2025-09-01T08:00:00.000Z",
      "deactivatedAt": null,
      "description": "Main seasonal collection for Spring and Summer 2026",
      "id": "coll-uuid-1",
      "isActive": true,
      "isPermanent": false,
      "name": "Spring / Summer 2026",
      "startDate": "2026-02-01",
      "updatedAt": "2026-01-15T10:00:00.000Z"
    },
    {
      "code": "BASICS",
      "createdAt": "2024-01-01T08:00:00.000Z",
      "deactivatedAt": null,
      "description": "Permanent core basics collection",
      "id": "coll-uuid-2",
      "isActive": true,
      "isPermanent": true,
      "name": "Basics",
      "startDate": null,
      "updatedAt": "2024-01-01T08:00:00.000Z"
    }
  ],
  "page": 1,
  "pageSize": 20,
  "total": 8
}

Authorizations

​
Authorization
string
header
required

User session token issued by NextAuth. For human users accessing Solya via the web application.

Query Parameters

​
page
integer
default:1

Page number, 1-indexed (default: 1)

Required range: 1 <= x <= 9007199254740991
​
pageSize
integer
default:20

Number of items per page, max 100 (default: 20)

Required range: 1 <= x <= 100
​
q
string

Case-insensitive substring search query

​
isActive
enum<string>

Filter by active status. true = active only, false = inactive only, omit = all collections.

Available options:
true,
false
​
sortBy
enum<string>

Sort field for the collection list. Allowed values: name, startDate, isActive.

Available options:
name,
startDate,
isActive
​
sortOrder
enum<string>

Sort direction: asc (ascending) or desc (descending).

Available options:
asc,
desc

Response

Successful response

​
data
object
required
​
success
enum<boolean>
required
Available options:
true