Choose your language:
    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
    name  string

    Name of the model

    apiKey  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

    modularBlock  boolean

    Whether this model is a modular content block or not

    tree  boolean

    Whether editors can organize records in a tree or not

    orderingDirection  enum, null

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

    orderingMeta  enum, null

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

    draftModeActive  boolean

    Whether draft/published mode is active or not

    allLocalesRequired  boolean

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

    collectionAppearance  enum

    The way the model collection should be presented to the editors

    hasSingletonItem  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

    singletonItem  item.id, null

    The item instance related to this item type

    fields  Array<field.id>

    The list of item type fields

    titleField  field.id, null

    The field to use as display title

    orderingField  field.id, null

    The field upon which the collection is sorted

    workflow  workflow.id, null

    The workflow to enforce on records

    Available endpoints