Show examples in:
    Model/Block

    The way you define the kind of content you can edit inside your administrative area passes through the concept of Models, which are much like database tables. For backward-compatibility reasons, the API refers to models as "item types".

    Object payload

    id  string
    ID of item type
    type  string
    Must be exactly "item_type"
    name  string

    Name of the model

    api_key  string

    API key of the model

    singleton  boolean

    Whether the model is single-instance or not

    sortable  boolean

    Whether editors can sort records via drag & drop or not

    modular_block  boolean

    Whether this model is a modular content block or not

    tree  boolean

    Whether editors can organize records in a tree or not

    ordering_direction  enum, null

    If an ordering field is set, this fields specify the sorting direction

    ordering_meta  enum, null

    Specifies the model's sorting method. Cannot be set in concurrency with ordering_field

    draft_mode_active  boolean

    Whether draft/published mode is active or not

    all_locales_required  boolean

    Whether we require all the project locales to be present for each localized field or not

    collection_appearance  enum

    The way the model collection should be presented to the editors

    has_singleton_item  boolean

    If this model is single-instance, this tells the single-instance record has already been created or not

    hint  string, null

    A hint shown to editors to help them understand the purpose of this model/block

    singleton_item  { type: "item", id: item.id }, null

    The item instance related to this item type

    fields  Array of { type: "field", id: field.id }

    The list of item type fields

    fieldsets  Array of { type: "fieldset", id: fieldset.id }

    The list of item type fieldsets

    title_field  { type: "field", id: field.id }, null

    The field to use as display title

    image_preview_field  { type: "field", id: field.id }, null

    The field to use as preview image

    excerpt_field  { type: "field", id: field.id }, null

    The field to use as fallback description for SEO purposes

    ordering_field  { type: "field", id: field.id }, null

    The field upon which the collection is sorted

    workflow  { type: "workflow", id: workflow.id }, null

    The workflow to enforce on records

    Available endpoints