List collections

Returns the collections owned by the caller within their organization, paginated. Set with_counts=true to include an estimated row_count per collection (from database statistics, near-free, ideal for dashboards; the exact count is available via the count endpoint). Rate limit: 100 requests/min per user.

GET /v1/collections

List collections

cURL

curl --request GET \
  --url https://{host}/v2/workspaces/slug:ai-collection-v3/webhooks/v1/collections \
  --header 'Authorization: Bearer <token>'

200

{
  "items": [
    {
      "collection_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "products",
      "description": "<string>",
      "owner_id": "<string>",
      "owner_type": "user",
      "agent_ids": [
        "<string>"
      ],
      "orgSlug": "<string>",
      "settings": {
        "ttl_days": 1,
        "max_records": 123
      },
      "schema": {
        "product_name": {
          "type": "text"
        },
        "price": {
          "type": "double"
        },
        "stock": {
          "type": "integer",
          "nullable": true
        },
        "active": {
          "type": "boolean"
        },
        "released_at": {
          "type": "date"
        },
        "specs": {
          "type": "json"
        }
      },
      "indexes": [
        {
          "properties": [
            "sku"
          ]
        }
      ],
      "uniques": [
        {
          "properties": [
            "sku"
          ]
        }
      ],
      "charts": [
        {
          "id": "<string>",
          "kind": "bar",
          "title": "<string>",
          "agg": "count",
          "field": "<string>",
          "dimension": "<string>"
        }
      ],
      "row_count": 123,
      "status": "ready"
    }
  ],
  "total": 123,
  "page": 123,
  "limit": 123
}

Authorizations

BearerAuthOrgApiKeyAuth

Authorization · string · header · required

User session JWT. Send as Authorization: Bearer <token>.

Query Parameters

limit · integer · default: 20

Page size (max 100).

Required range: 1 <= x <= 100

page · integer · default: 1

Page number.

Required range: x >= 1

with_counts · boolean

Include an estimated row_count on each returned collection.

Response

200

application/json

Collections accessible to the caller (paginated).

items · object[]

Hide child attributes

items. collection_id · string<uuid>

items. name · string

Example:

"products"

items. description · string

items. owner_id · string

User ID or agent ID owning the collection.

items. owner_type · enum<string>

Available options: user, agent

items. agent_ids · string[]

Agents granted access (sharing list).

items. orgSlug · string

Organization the collection belongs to (tenant boundary).

items. settings · object

Hide child attributes

items.settings. ttl_days · integer

Default record expiration in days (0 = never).

Required range: x >= 0

items.settings. max_records · integer

Collection size limit (default 10,000).

items. schema · object

Column definitions: field name → type descriptor.

Hide child attributes

items.schema. {key} · object

Hide child attributes

items.schema.{key}. type · enum<string> · required

Available options: text, integer, double, boolean, date, datetime, json, array

items.schema.{key}. nullable · boolean

Example:

{
  "product_name": { "type": "text" },
  "price": { "type": "double" },
  "stock": { "type": "integer", "nullable": true },
  "active": { "type": "boolean" },
  "released_at": { "type": "date" },
  "specs": { "type": "json" }
}

items. indexes · object[]

Hide child attributes

items.indexes. properties · string[] · required

Example:

["sku"]

items. uniques · object[]

Hide child attributes

items.uniques. properties · string[] · required

Example:

["sku"]

items. charts · object[]

Hide child attributes

items.charts. id · string

items.charts. kind · string

e.g. kpi, bar, line.

Example:

"bar"

items.charts. title · string

items.charts. agg · string

Example:

"count"

items.charts. field · string

items.charts. dimension · string

items. row_count · integer

On list with with_counts=true, an estimated count; null otherwise.

items. status · string

Example:

"ready"

total · integer

Total number of collections for the caller.

page · integer

limit · integer