API ReferenceCollections

List Collections

Retrieve all collections belonging to 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.

Authentication

x-api-keystring
API Key authentication via header

Query parameters

skipintegerOptional>=0Defaults to 0
Number of collections to skip for pagination
limitintegerOptional1-1000Defaults to 100

Maximum number of collections to return (1-1000)

searchstringOptional

Search term to filter collections by name or readable_id

Response

Successful Response
namestring

Human-readable display name for the collection.

readable_idstring

URL-safe unique identifier used in API endpoints. This becomes non-optional once the collection is created.

idstringformat: "uuid"
Unique system identifier for the collection. This UUID is generated automatically and used for internal references.
created_atstringformat: "date-time"

Timestamp when the collection was created (ISO 8601 format).

modified_atstringformat: "date-time"

Timestamp when the collection was last modified (ISO 8601 format).

organization_idstringformat: "uuid"
Identifier of the organization that owns this collection. Collections are isolated per organization.
vector_sizeinteger

Vector dimensions used by this collection (derived from deployment metadata).

embedding_model_namestring

Name of the embedding model used for this collection (derived from deployment metadata).

sync_configobject or null
Default sync configuration for all syncs in this collection. Overridable at sync and job level.
created_by_emailstring or nullformat: "email"
Email address of the user who created this collection.
modified_by_emailstring or nullformat: "email"
Email address of the user who last modified this collection.
statusenum or null
Current operational status of the collection:<br/>• **NEEDS_SOURCE**: Collection has no authenticated connections, or connections exist but haven't synced yet<br/>• **ACTIVE**: At least one connection has completed a sync or is currently syncing<br/>• **ERROR**: All connections have failed their last sync
Allowed values:

Errors