flatfile.com home pagelight logo
Blueprint
Overview

​
Terms

  • Blueprint — A collection of sheets that describe a complete dataset
  • Sheet — A collection of fields that describe a single entity (eg. people, products, companies)
  • Field — Describes an attribute of the entity (eg. name, email) and how it should behave
{
  "sheets": [
    {
      "key": "products",
      "label": "Products",
      "description": "A list of products available for sale",
      "fields": [
        {
          "key": "code",
          "label": "Product Code",
          "type": "string"
        },
        {
          "key": "description",
          "type": "string"
        },
        {
          "key": "price",
          "type": "number"
        }
      ]
    }
  ]
}

Field Types

Learn about the different field types and how to use them.

Field Constraints

Learn about the available constraints and how they work.

Field Relationships

Establish connections between sheets and fields.

Access Control

Configure field, sheet, and workbook level user capabilities.