Craft Documents icon

Craft Documents

Interact with Craft Multi-Document API - manage documents, blocks, collections, and search

Actions14

Collection → List

AI-generated

Summary

List all collections available in Craft documents, optionally filtering collections by specified document IDs using include or exclude modes.

Inputs

  • Filter by Documents — Toggle to filter collections by specific document IDs.
  • Document IDs — Comma-separated or JSON array of document IDs to include or exclude collections from, active only if 'Filter by Documents' is true.
  • Filter Mode — Select whether to include or exclude collections from the specified documents; applies only if filtering by documents is enabled.
  • Request Options — Optional request settings such as batching, proxy, SSL ignoring, and timeout to control API request behavior.

Output shape

a list of collection objects

Returns an array of collection metadata objects. Each collection includes at least a key (ID) and a name, optionally indicating the document it belongs to. The list respects the document filtering parameters when provided. The API response is paginated internally but presented as a complete list to the user.

Examples

Example 1: Fetch all collections across all documents without filtering.

Set 'Filter by Documents' to false (default); no document IDs or filter mode required.

Links

Discussion