Skip to main content
GET
/
api
/
v1
/
collections
Read Collections
curl --request GET \
  --url https://api.example.com/api/v1/collections \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "workspace_id": "<string>",
      "created_at": "<string>",
      "updated_at": "<string>",
      "description": "<string>",
      "store_type": "<string>",
      "visibility": "private",
      "status": "active",
      "tags": [
        "<string>"
      ],
      "parent_id": "<string>",
      "stats": {},
      "meta_data": {},
      "settings": {},
      "embedding": {},
      "source_type": "document",
      "source_id": "<string>",
      "created_by": "<string>"
    }
  ],
  "total_count": 123,
  "page": 123,
  "limit": 123,
  "next_page": 123,
  "next_cursor": "<string>",
  "has_more": true
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-Workspace-Id
string | null

The workspace ID

Query Parameters

skip
integer
default:0

Number of collections to skip

Required range: x >= 0
limit
integer
default:100

Number of collections to return

Required range: 1 <= x <= 1000
status
string | null

Filter by collection status

visibility
string | null

Filter by visibility (public/private)

search
string | null

Search collections by name or description

tags
string | null

Filter by tags (comma-separated)

Response

Successful Response

data
CollectionRead · object[]
required
total_count
integer
required
page
integer | null
limit
integer | null
next_page
integer | null
next_cursor
string | null
has_more
boolean | null