Skip to main content
GET
/
v1
/
collections
List Collections
curl --request GET \
  --url https://api.example.com/v1/collections
{
  "id": "<string>",
  "name": "<string>",
  "readable_id": "<string>",
  "status": "<string>",
  "vector_size": 123,
  "embedding_model_name": "<string>",
  "organization_id": "<string>",
  "created_at": "<string>",
  "modified_at": "<string>",
  "created_by_email": "<string>",
  "modified_by_email": "<string>",
  "sync_config": {}
}

​
Overview

Retrieve all collections in your organization. Collections are containers that group related data from one or more source connections, enabling unified search across multiple data sources. Results are sorted by creation date (newest first) and support pagination and text search filtering.

​
Query Parameters

​
skip
integer
default:0
Number of collections to skip for pagination (minimum: 0)
​
limit
integer
default:100
Maximum number of collections to return (1-1000)
​
search
string
Search term to filter collections by name or readable_id (e.g., “customer”)

​
Response

Returns an array of collection objects.
​
id
string
required
Unique UUID identifier for the collection
​
name
string
required
Human-readable display name
​
readable_id
string
required
URL-safe unique identifier used in API endpoints
​
status
string
required
Current operational status: NEEDS_SOURCE, ACTIVE, or ERROR
​
vector_size
integer
required
Vector dimensions used by this collection
​
embedding_model_name
string
required
Name of the embedding model used
​
organization_id
string
required
UUID of the organization that owns this collection
​
created_at
string
required
ISO 8601 timestamp when created
​
modified_at
string
required
ISO 8601 timestamp when last modified
​
created_by_email
string
Email of the user who created this collection
​
modified_by_email
string
Email of the user who last modified this collection
​
sync_config
object
Default sync configuration for all syncs in this collection

​
Example Request

curl https://api.airweave.ai/v1/collections?limit=10 \
  -H "Authorization: Bearer YOUR_API_KEY"

​
Example Response

[
  {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Finance Data",
    "readable_id": "finance-data-ab123",
    "vector_size": 3072,
    "embedding_model_name": "text-embedding-3-large",
    "sync_config": null,
    "created_at": "2024-01-15T09:30:00Z",
    "modified_at": "2024-01-15T14:22:15Z",
    "organization_id": "org12345-6789-abcd-ef01-234567890abc",
    "created_by_email": "admin@company.com",
    "modified_by_email": "finance@company.com",
    "status": "ACTIVE"
  }
]

​
Status Values

  • NEEDS_SOURCE: Collection has no authenticated connections, or connections exist but haven’t synced yet
  • ACTIVE: At least one connection has completed a sync or is currently syncing
  • ERROR: All connections have failed their last sync