Read Collections

Retrieve collections with pagination.

Returns a paginated list of collections with filtering options.

Args: skip: Number of records to skip (for pagination) limit: Maximum number of records to return status: Filter by collection status (e.g., ‘active’, ‘archived’) visibility: Filter by visibility (‘public’ or ‘private’) search: Search term for name or description tags: Comma-separated list of tags to filter by

Returns: PaginatedResponse with collections and total count

Examples: Get first page: GET /collections?skip=0&limit=20

Get second page: GET /collections?skip=20&limit=20

Filter by status: GET /collections?status=active&limit=50

Search collections: GET /collections?search=documents&limit=20

Filter by tags: GET /collections?tags=important,work&limit=50

GET /api/v1/collections

Read Collections

cURL

curl --request GET \
  --url https://api.example.com/api/v1/collections \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.example.com/api/v1/collections"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.example.com/api/v1/collections', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/api/v1/collections",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/api/v1/collections"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.example.com/api/v1/collections")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/collections")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

{
  "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
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

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

200

application/json

Successful Response

data · CollectionRead · object[] · required

Show child attributes

total_count · integer · required

page · integer | null

limit · integer | null

next_page · integer | null

next_cursor · string | null

has_more · boolean | null