---
updatedAt: 2026-04-24T15:12:04.000Z
agentTools:
  projectIndex: https://docs.beauhurst.com/llms.txt
---

# List Subscription Collections metadata.


        List Subscription Collections metadata (ID, Name, Item Count, Collection Type, Created Date, Created By) for the Collections in your Subscription.
        Supports filtering by date the collection has been modified, created date and collection type.
        

# OpenAPI definition

```json
{
  "openapi": "3.0.3",
  "info": {
    "title": "Beauhurst API v2",
    "version": "1.0.0 (externalapi)",
    "description": "<h3>Usage</h3><p>The API only accepts <code>GET</code> requests over HTTPS.</p><h3>Authorization</h3><p>The Beauhurst API requires authentication in the form of an API key,provided in the format <code>'apikey <your-api-key>'</code>.<br><br>To obtain an API key, please contact your subscription's account manager at Beauhurst. Be sure to keep this key <strong>private</strong> and <strong>secure</strong>.</p>"
  },
  "paths": {
    "/collections/": {
      "get": {
        "operationId": "collections_list",
        "description": "\n        List Subscription Collections metadata (ID, Name, Item Count, Collection Type, Created Date, Created By) for the Collections in your Subscription.\n        Supports filtering by date the collection has been modified, created date and collection type.\n        ",
        "summary": "List Subscription Collections metadata.",
        "parameters": [
          {
            "in": "query",
            "name": "collection_type",
            "schema": {
              "enum": [
                "truecompany",
                "fund",
                "accelerator",
                "fundraising",
                "mbombi",
                "acquisition",
                "corporatespinout",
                "ipo",
                "grant",
                "person"
              ],
              "type": "string",
              "minLength": 1
            },
            "description": "* `truecompany` - True Company\n* `fund` - Fund\n* `accelerator` - Accelerator\n* `fundraising` - Fundraising\n* `mbombi` - Mbo/Mbi\n* `acquisition` - Acquisition\n* `corporatespinout` - Corporate Spin-Out\n* `ipo` - Ipo\n* `grant` - Grant\n* `person` - Person"
          },
          {
            "name": "created_after",
            "required": false,
            "in": "query",
            "description": "Return collections created at or after the datetime provided",
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          },
          {
            "name": "created_before",
            "required": false,
            "in": "query",
            "description": "Return collections created at or before the datetime provided",
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          },
          {
            "name": "limit",
            "required": false,
            "in": "query",
            "description": "Number of results to return per page.",
            "schema": {
              "type": "integer"
            }
          },
          {
            "in": "query",
            "name": "modified_since",
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          },
          {
            "name": "offset",
            "required": false,
            "in": "query",
            "description": "The initial index from which to return the results.",
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "sort",
            "required": false,
            "in": "query",
            "description": "Sort by name or created_at. Prefix with '-' for descending order.\n\n* `name` - name\n* `-name` - -name\n* `created_at` - created_at\n* `-created_at` - -created_at",
            "schema": {
              "type": "string",
              "enum": [
                "name",
                "-name",
                "created_at",
                "-created_at"
              ],
              "minLength": 1
            }
          }
        ],
        "tags": [
          "collections"
        ],
        "security": [
          {
            "tokenAuth": []
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PaginatedCollectionSearchList"
                }
              }
            },
            "description": ""
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "CollectionSearch": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string",
            "readOnly": true
          },
          "count": {
            "type": "integer"
          },
          "collection_type": {
            "type": "string",
            "readOnly": true
          },
          "created_at": {
            "type": "string",
            "format": "date-time"
          },
          "created_by": {
            "type": "string"
          }
        },
        "required": [
          "collection_type",
          "count",
          "created_at",
          "created_by",
          "id",
          "name"
        ]
      },
      "PaginatedCollectionSearchList": {
        "type": "object",
        "properties": {
          "meta": {
            "type": "object",
            "properties": {
              "total": {
                "type": "integer",
                "example": 10
              },
              "limit": {
                "type": "integer",
                "example": 10
              },
              "offset": {
                "type": "integer",
                "example": 10
              },
              "count": {
                "type": "integer",
                "example": 10
              }
            }
          },
          "results": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CollectionSearch"
            }
          }
        }
      }
    },
    "securitySchemes": {
      "tokenAuth": {
        "type": "apiKey",
        "in": "header",
        "name": "Authorization",
        "description": "Token-based authentication with required prefix \"APIkey\""
      }
    }
  },
  "servers": [
    {
      "url": "/_api/v2.0"
    }
  ]
}
```