List Collections | Captain Docs

curl https://api.runcaptain.com/v2/collections \
     -H "Authorization: Bearer YOUR_API_KEY" \
     -H "X-Organization-ID: YOUR_ORG_UUID" \
     -H "Content-Type: application/json"

{
  "collections": [
    {
      "collection_id": "col_finance_2024q2",
      "collection_name": "financial_reports_q2_2024",
      "environment": "production",
      "is_active": true,
      "created_at": "2024-04-10T09:15:00Z",
      "request_count": 3427,
      "document_count": 158
    },
    {
      "collection_id": "col_hr_policies",
      "collection_name": "hr_policies_2023",
      "environment": "staging",
      "is_active": false,
      "created_at": "2023-11-05T14:45:00Z",
      "request_count": 890,
      "document_count": 27
    },
    {
      "collection_id": "col_marketing_assets",
      "collection_name": "marketing_assets_2024",
      "environment": "development",
      "is_active": true,
      "created_at": "2024-02-20T11:00:00Z",
      "request_count": 134,
      "document_count": 76
    }
  ],
  "total_count": 3,
  "limit": 100,
  "offset": 0
}

List all collections for an organization.

Returns an array of collection objects with collection_name, collection_id, and document_count.

Query parameters

limitintegerOptionalDefaults to 100

Maximum number of collections to return

offsetintegerOptionalDefaults to 0

Pagination offset

Response

Successful Response

collectionslist of objects

List of collections

total_countinteger

Number of collections returned

limitinteger

Maximum number of collections per page

offsetinteger

Pagination offset

Headers

Query parameters

Response