Content Management API > Model filter

Model filter

In DatoCMS you can create filters to help you (and other editors) quickly search for records

Object payload

id string

RFC 4122 UUID of filter expressed in URL-safe base64 format

Example:

"FF-P5of6Qp-DD2w0xoaa6Q"

type string

Must be exactly "item_type_filter".

name string

The name of the filter

Example:

"Draft posts"

filter object

The actual filter. It follows the form of the filter query parameter of the List all records endpoint.

Example:

{
  query: "foo bar",
  fields: {
    _status: { eq: "draft" },
    title: {
      matches: { pattern: "qux", case_sensitive: "false", regexp: "false" },
    },
  },
}

columns

The columns to show with this filter

Type: Array<object>, null

Example:

[
  { name: "_preview", width: 0.6 },
  { name: "slug", width: 0.1 },
  { name: "_status", width: 0.1 },
  { name: "_updated_at", width: 0.2 },
]

name string

Can be either the API key of a model's field, or one of the following meta columns: id, _preview, _updated_at, _created_at, _creator, _status, _published_at, _first_published_at, _publication_scheduled_at, _unpublishing_scheduled_at, position (only for sortable models), `_stage (only for models associated with a workflow).

width number

The percentage width for the column (float, from 0 to 1.0)

order_by string, null

The ordering to apply with this filter, or null for the default model ordering. It follows the form of the order_by query parameter of the List all records endpoint.

Example:

"_updated_at_ASC"

shared boolean

Whether it's a shared filter or not

item_type

Model associated with the filter

Type: ResourceLinkage<"item_type">

Model filter

Object payload

Available endpoints