Framer icon

Framer

Read and write Framer CMS, publish previews, deploy to production

Site Manager (Compound) → Read Structure

AI-generated

Summary

Reads the Framer project’s CMS structure, listing each collection’s name, ID, slug, item count, and field names, types, and IDs. Supply the Framer API credentials; the Input JSON parameter defaults to the incoming item’s JSON, but this operation does not use its payload.

Inputs

  • Input JSON — Defaults to the incoming item’s JSON and accepts a v4 webhook compatible payload. Read Structure does not consume payload fields.

Output shape

A single result object per input item, wrapped in data alongside resource and operation.

data contains success: true, action: "readStructure", and a collections array. Each collection includes name, id, slug, itemCount, and fields (each with name, type, and id). If reading a collection’s fields fails, its fields entry contains an error; if reading its items fails, its item count is 0. Errors can be returned per item when Continue On Fail is enabled.

Examples

Example 1: Discover CMS collections and their schemas before building workflows

Choose Site Manager (Compound) > Read Structure and connect Framer API credentials. Leave Input JSON at its default; the operation does not use its payload.

Links

Discussion