You can supply different parameters to the filter argument to filter the query response accordingly. The available options depend on the fields defined on the model in question.

If you supply exactly one parameter to the filter argument, the query response will only contain records that fulfill this constraint:

1
query {
2
  allArtists(
3
    filter: {
4
      published: { eq: false }
5
    }
6
  ) {
7
    id
8
    name
9
    published
10
  }
11
}

Depending on the type of the field you want to filter by, you have access to different advanced criteria you can use to filter your query response:

1
query {
2
  allArtists(
3
    filter: {
4
      name: { in: [ "Blank Banshee", "Gazelle Twin" ] }
5
    }
6
  ) {
7
    id
8
    name
9
    genre
10
  }
11
}

If you specify multiple conditions, they will be combined as if it was a logical AND expression:

1
query {
2
  allAlbums(
3
    filter: {
4
      { artist: { eq: "212" } },
5
      { releaseDate: { gt: "2016-01-01" } }
6
    }
7
  ) {
8
    id
9
    slug
10
    artist { name }
11
    coverImage { url }
12
  }
13
}

There are times where it can be more convenient to use an AND expression explicitly, for example when you need to use the same type of filter more than once:

1
query {
2
  allArtists(
3
    filter: {
4
      AND: [
5
        { name: { matches: { pattern: "Blank" } } },
6
        { name: { matches: { pattern: "Banshee" } } }
7
      ]
8
    }
9
  ) {
10
    id
11
    name
12
    genre
13
  }
14
}

It is also possible to combine AND-like and OR logical expressions. For example, the following query will return all the point of interest located in New York that either have a rating greater than 4 or are a restaurant:

1
query {
2
  allPois(
3
    filter: {
4
      address: { matches: { pattern: "new york" } },
5
      OR: [
6
        { rating: { gt: 4 } },
7
        { name: { matches: { pattern: "restaurant" } } },
8
      ]
9
    }
10
  ) {
11
    name
12
    address
13
    rating
14
  }
15
}

Structured Text and Deep Filtering

If a Structured Text field has the deep filtering option enabled, its filters will slightly differ from the ones described in this page. You learn more in the next section of the doc regarding deep filtering.

Filters available for field types

Boolean fields

Search for records with an exact match

1
query {
2
  allProducts(filter: { booleanField: { eq: true } }) {
3
    title
4
  }
5
}

Color fields

Filter records with the specified field defined (i.e. with any value) or not

1
query {
2
  allProducts(filter: { colorField: { exists: true } }) {
3
    title
4
  }
5
}

Date fields

Filter records with a value that's strictly greater than the one specified

1
query {
2
  allProducts(filter: { dateField: { gt: "2018-02-13" } }) {
3
    title
4
  }
5
}

Filter records with a value that's less than the one specified

1
query {
2
  allProducts(filter: { dateField: { lt: "2018-02-13" } }) {
3
    title
4
  }
5
}

Filter records with a value that's greater than or equal to the one specified

1
query {
2
  allProducts(filter: { dateField: { gte: "2018-02-13" } }) {
3
    title
4
  }
5
}

Filter records with a value that's less or equal than the one specified

1
query {
2
  allProducts(filter: { dateField: { lte: "2018-02-13" } }) {
3
    title
4
  }
5
}

Filter records with the specified field defined (i.e. with any value) or not

1
query {
2
  allProducts(filter: { dateField: { exists: true } }) {
3
    title
4
  }
5
}

Search for records with an exact match

1
query {
2
  allProducts(filter: { dateField: { eq: "2018-02-13" } }) {
3
    title
4
  }
5
}

Exclude records with an exact match

1
query {
2
  allProducts(filter: { dateField: { neq: "2018-02-13" } }) {
3
    title
4
  }
5
}

DateTime fields

Filter records with a value that's strictly greater than the one specified. Seconds and milliseconds are truncated from the argument.

1
query {
2
  allProducts(
3
    filter: {
4
      dateTimeField: {
5
        gt: "2018-02-13T14:30:00+00:00"
6
      }
7
    }
8
  ) {
9
    title
10
  }
11
}

Filter records with a value that's less than the one specified. Seconds and milliseconds are truncated from the argument.

1
query {
2
  allProducts(
3
    filter: {
4
      dateTimeField: {
5
        lt: "2018-02-13T14:30:00+00:00"
6
      }
7
    }
8
  ) {
9
    title
10
  }
11
}

Filter records with a value that's greater than or equal to than the one specified. Seconds and milliseconds are truncated from the argument.

1
query {
2
  allProducts(
3
    filter: {
4
      dateTimeField: {
5
        gte: "2018-02-13T14:30:00+00:00"
6
      }
7
    }
8
  ) {
9
    title
10
  }
11
}

Filter records with a value that's less or equal than the one specified. Seconds and milliseconds are truncated from the argument.

1
query {
2
  allProducts(
3
    filter: {
4
      dateTimeField: {
5
        lte: "2018-02-13T14:30:00+00:00"
6
      }
7
    }
8
  ) {
9
    title
10
  }
11
}

Filter records with a value that's within the specified minute range. Seconds and milliseconds are truncated from the argument.

1
query {
2
  allProducts(
3
    filter: {
4
      dateTimeField: {
5
        eq: "2018-02-13T14:30:00+00:00"
6
      }
7
    }
8
  ) {
9
    title
10
  }
11
}

Filter records with a value that's outside the specified minute range. Seconds and milliseconds are truncated from the argument.

1
query {
2
  allProducts(
3
    filter: {
4
      dateTimeField: {
5
        neq: "2018-02-13T14:30:00+00:00"
6
      }
7
    }
8
  ) {
9
    title
10
  }
11
}

Filter records with the specified field defined (i.e. with any value) or not

1
query {
2
  allProducts(filter: { dateTimeField: { exists: true } }) {
3
    title
4
  }
5
}

Single file fields

Search for records with an exact match. The specified value must be an Upload ID

1
query {
2
  allProducts(filter: { fileField: { eq: "123" } }) {
3
    title
4
  }
5
}

Exclude records with an exact match. The specified value must be an Upload ID

1
query {
2
  allProducts(filter: { fileField: { neq: "123" } }) {
3
    title
4
  }
5
}

Filter records that have one of the specified uploads

1
query {
2
  allProducts(filter: { fileField: { in: ["123"] } }) {
3
    title
4
  }
5
}

Filter records that do not have one of the specified uploads

1
query {
2
  allProducts(filter: { fileField: { notIn: ["123"] } }) {
3
    title
4
  }
5
}

Filter records with the specified field defined (i.e. with any value) or not

1
query {
2
  allProducts(filter: { fileField: { exists: true } }) {
3
    title
4
  }
5
}

Floating-point number fields

Filter records with a value that's strictly greater than the one specified

1
query {
2
  allProducts(filter: { floatField: { gt: 19.99 } }) {
3
    title
4
  }
5
}

Filter records with a value that's less than the one specified

1
query {
2
  allProducts(filter: { floatField: { lt: 19.99 } }) {
3
    title
4
  }
5
}

Filter records with a value that's greater than or equal to the one specified

1
query {
2
  allProducts(filter: { floatField: { gte: 19.99 } }) {
3
    title
4
  }
5
}

Filter records with a value that's less or equal than the one specified

1
query {
2
  allProducts(filter: { floatField: { lte: 19.99 } }) {
3
    title
4
  }
5
}

Filter records with the specified field defined (i.e. with any value) or not

1
query {
2
  allProducts(filter: { floatField: { exists: true } }) {
3
    title
4
  }
5
}

Search for records with an exact match

1
query {
2
  allProducts(filter: { floatField: { eq: 19.99 } }) {
3
    title
4
  }
5
}

Exclude records with an exact match

1
query {
2
  allProducts(filter: { floatField: { neq: 19.99 } }) {
3
    title
4
  }
5
}

Multiple files fields

Search for records with an exact match. The specified values must be Upload IDs

1
query {
2
  allProducts(filter: { galleryField: { eq: ["123"] } }) {
3
    title
4
  }
5
}

Filter records that have all of the specified uploads. The specified values must be Upload IDs

1
query {
2
  allProducts(filter: { galleryField: { allIn: ["123"] } }) {
3
    title
4
  }
5
}

Filter records that have one of the specified uploads. The specified values must be Upload IDs

1
query {
2
  allProducts(filter: { galleryField: { anyIn: ["123"] } }) {
3
    title
4
  }
5
}

Filter records that do not have any of the specified uploads. The specified values must be Upload IDs

1
query {
2
  allProducts(filter: { galleryField: { notIn: ["123"] } }) {
3
    title
4
  }
5
}

Filter records with the specified field defined (i.e. with any value) or not

1
query {
2
  allProducts(filter: { galleryField: { exists: true } }) {
3
    title
4
  }
5
}

Integer number fields

Filter records with a value that's strictly greater than the one specified

1
query {
2
  allProducts(filter: { integerField: { gt: 3 } }) {
3
    title
4
  }
5
}

Filter records with a value that's less than the one specified

1
query {
2
  allProducts(filter: { integerField: { lt: 3 } }) {
3
    title
4
  }
5
}

Filter records with a value that's greater than or equal to the one specified

1
query {
2
  allProducts(filter: { integerField: { gte: 3 } }) {
3
    title
4
  }
5
}

Filter records with a value that's less or equal than the one specified

1
query {
2
  allProducts(filter: { integerField: { lte: 3 } }) {
3
    title
4
  }
5
}

Filter records with the specified field defined (i.e. with any value) or not

1
query {
2
  allProducts(filter: { integerField: { exists: true } }) {
3
    title
4
  }
5
}

Search for records with an exact match

1
query {
2
  allProducts(filter: { integerField: { eq: 3 } }) {
3
    title
4
  }
5
}

Exclude records with an exact match

1
query {
2
  allProducts(filter: { integerField: { neq: 3 } }) {
3
    title
4
  }
5
}

JSON fields

Filter records with the specified field defined (i.e. with any value) or not

1
query {
2
  allProducts(filter: { jsonField: { exists: true } }) {
3
    title
4
  }
5
}

Geolocation fields

Filter records within the specified radius in meters

1
query {
2
  allProducts(
3
    filter: {
4
      latLonField: {
5
        near: { latitude: 40.73, longitude: -73.93, radius: 10 }
6
      }
7
    }
8
  ) {
9
    title
10
  }
11
}

Filter records with the specified field defined (i.e. with any value) or not

1
query {
2
  allProducts(filter: { latLonField: { exists: true } }) {
3
    title
4
  }
5
}

Single link fields

Search for records with an exact match. The specified value must be a Record ID

1
query {
2
  allProducts(filter: { linkField: { eq: "123" } }) {
3
    title
4
  }
5
}

Exclude records with an exact match. The specified value must be a Record ID

1
query {
2
  allProducts(filter: { linkField: { neq: "123" } }) {
3
    title
4
  }
5
}

Filter records linked to one of the specified records

1
query {
2
  allProducts(filter: { linkField: { in: ["123"] } }) {
3
    title
4
  }
5
}

Filter records not linked to one of the specified records

1
query {
2
  allProducts(filter: { linkField: { notIn: ["123"] } }) {
3
    title
4
  }
5
}

Filter records with the specified field defined (i.e. with any value) or not

1
query {
2
  allProducts(filter: { linkField: { exists: true } }) {
3
    title
4
  }
5
}

Multiple links fields

Search for records with an exact match. The specified values must be Record IDs

1
query {
2
  allProducts(filter: { linksField: { eq: ["123"] } }) {
3
    title
4
  }
5
}

Filter records linked to all of the specified records. The specified values must be Record IDs

1
query {
2
  allProducts(filter: { linksField: { allIn: ["123"] } }) {
3
    title
4
  }
5
}

Filter records linked to at least one of the specified records. The specified values must be Record IDs

1
query {
2
  allProducts(filter: { linksField: { anyIn: ["123"] } }) {
3
    title
4
  }
5
}

Filter records not linked to any of the specified records. The specified values must be Record IDs

1
query {
2
  allProducts(filter: { linksField: { notIn: ["123"] } }) {
3
    title
4
  }
5
}

Filter records with the specified field defined (i.e. with any value) or not

1
query {
2
  allProducts(filter: { linksField: { exists: true } }) {
3
    title
4
  }
5
}

SEO meta tags fields

Filter records with the specified field defined (i.e. with any value) or not

1
query {
2
  allProducts(filter: { seoField: { exists: true } }) {
3
    title
4
  }
5
}

Slug fields

Search for records with an exact match

1
query {
2
  allProducts(filter: { slugField: { eq: "bike" } }) {
3
    title
4
  }
5
}

Exclude records with an exact match

1
query {
2
  allProducts(filter: { slugField: { neq: "bike" } }) {
3
    title
4
  }
5
}

Filter records that have one of the specified slugs

1
query {
2
  allProducts(filter: { slugField: { in: ["bike"] } }) {
3
    title
4
  }
5
}

Filter records that do have one of the specified slugs

1
query {
2
  allProducts(filter: { slugField: { notIn: ["bike"] } }) {
3
    title
4
  }
5
}

Single-line string fields

Filter records based on a regular expression

1
query {
2
  allProducts(
3
    filter: {
4
      stringField: {
5
        matches: { pattern: "bi(cycl|k)e", caseSensitive: false }
6
      }
7
    }
8
  ) {
9
    title
10
  }
11
}

Exclude records based on a regular expression

1
query {
2
  allProducts(
3
    filter: {
4
      stringField: {
5
        notMatches: { pattern: "bi(cycl|k)e", caseSensitive: false }
6
      }
7
    }
8
  ) {
9
    title
10
  }
11
}

Filter records with the specified field set as blank (null or empty string)

1
query {
2
  allProducts(filter: { stringField: { isBlank: true } }) {
3
    title
4
  }
5
}

Filter records with the specified field present (neither null, nor empty string)

1
query {
2
  allProducts(filter: { stringField: { isPresent: true } }) {
3
    title
4
  }
5
}

Search for records with an exact match

1
query {
2
  allProducts(filter: { stringField: { eq: "bike" } }) {
3
    title
4
  }
5
}

Exclude records with an exact match

1
query {
2
  allProducts(filter: { stringField: { neq: "bike" } }) {
3
    title
4
  }
5
}

Filter records that equal one of the specified values

1
query {
2
  allProducts(filter: { stringField: { in: ["bike"] } }) {
3
    title
4
  }
5
}

Filter records that do not equal one of the specified values

1
query {
2
  allProducts(filter: { stringField: { notIn: ["bike"] } }) {
3
    title
4
  }
5
}

Filter records with the specified field defined (i.e. with any value) or not [DEPRECATED]

1
query {
2
  allProducts(filter: { stringField: { exists: true } }) {
3
    title
4
  }
5
}

Structured text fields

Filter records based on a regular expression

1
query {
2
  allProducts(
3
    filter: {
4
      structuredTextField: {
5
        matches: { pattern: "bi(cycl|k)e", caseSensitive: false }
6
      }
7
    }
8
  ) {
9
    title
10
  }
11
}

Exclude records based on a regular expression

1
query {
2
  allProducts(
3
    filter: {
4
      structuredTextField: {
5
        notMatches: { pattern: "bi(cycl|k)e", caseSensitive: false }
6
      }
7
    }
8
  ) {
9
    title
10
  }
11
}

Filter records with the specified field set as blank (null or single empty paragraph)

1
query {
2
  allProducts(filter: { structuredTextField: { isBlank: true } }) {
3
    title
4
  }
5
}

Filter records with the specified field present (neither null, nor empty string)

1
query {
2
  allProducts(filter: { structuredTextField: { isPresent: true } }) {
3
    title
4
  }
5
}

Filter records with the specified field defined (i.e. with any value) or not [DEPRECATED]

1
query {
2
  allProducts(filter: { structuredTextField: { exists: true } }) {
3
    title
4
  }
5
}

Multiple-paragraph text fields

Filter records based on a regular expression

1
query {
2
  allProducts(
3
    filter: {
4
      textField: {
5
        matches: { pattern: "bi(cycl|k)e", caseSensitive: false }
6
      }
7
    }
8
  ) {
9
    title
10
  }
11
}

Exclude records based on a regular expression

1
query {
2
  allProducts(
3
    filter: {
4
      textField: {
5
        notMatches: { pattern: "bi(cycl|k)e", caseSensitive: false }
6
      }
7
    }
8
  ) {
9
    title
10
  }
11
}

Filter records with the specified field set as blank (null or empty string)

1
query {
2
  allProducts(filter: { textField: { isBlank: true } }) {
3
    title
4
  }
5
}

Filter records with the specified field present (neither null, nor empty string)

1
query {
2
  allProducts(filter: { textField: { isPresent: true } }) {
3
    title
4
  }
5
}

Filter records with the specified field defined (i.e. with any value) or not [DEPRECATED]

1
query {
2
  allProducts(filter: { textField: { exists: true } }) {
3
    title
4
  }
5
}

Video fields

Filter records with the specified field defined (i.e. with any value) or not

1
query {
2
  allProducts(filter: { videoField: { exists: true } }) {
3
    title
4
  }
5
}

Filters available for meta fields

Filter by `_createdAt` meta field

Filter records with a value that's strictly greater than the one specified. Seconds and milliseconds are truncated from the argument.

1
query {
2
  allProducts(
3
    filter: {
4
      _createdAt: {
5
        gt: "2018-02-13T14:30:00+00:00"
6
      }
7
    }
8
  ) {
9
    title
10
  }
11
}

Filter records with a value that's less than the one specified. Seconds and milliseconds are truncated from the argument.

1
query {
2
  allProducts(
3
    filter: {
4
      _createdAt: {
5
        lt: "2018-02-13T14:30:00+00:00"
6
      }
7
    }
8
  ) {
9
    title
10
  }
11
}

Filter records with a value that's greater than or equal to than the one specified. Seconds and milliseconds are truncated from the argument.

1
query {
2
  allProducts(
3
    filter: {
4
      _createdAt: {
5
        gte: "2018-02-13T14:30:00+00:00"
6
      }
7
    }
8
  ) {
9
    title
10
  }
11
}

Filter records with a value that's less or equal than the one specified. Seconds and milliseconds are truncated from the argument.

1
query {
2
  allProducts(
3
    filter: {
4
      _createdAt: {
5
        lte: "2018-02-13T14:30:00+00:00"
6
      }
7
    }
8
  ) {
9
    title
10
  }
11
}

Filter records with a value that's within the specified minute range. Seconds and milliseconds are truncated from the argument.

1
query {
2
  allProducts(
3
    filter: {
4
      _createdAt: {
5
        eq: "2018-02-13T14:30:00+00:00"
6
      }
7
    }
8
  ) {
9
    title
10
  }
11
}

Filter records with a value that's outside the specified minute range. Seconds and milliseconds are truncated from the argument.

1
query {
2
  allProducts(
3
    filter: {
4
      _createdAt: {
5
        neq: "2018-02-13T14:30:00+00:00"
6
      }
7
    }
8
  ) {
9
    title
10
  }
11
}

Filter records with the specified field defined (i.e. with any value) or not

1
query {
2
  allProducts(filter: { _createdAt: { exists: true } }) {
3
    title
4
  }
5
}

Filter by `_firstPublishedAt` meta field

Filter records with a value that's strictly greater than the one specified. Seconds and milliseconds are truncated from the argument.

1
query {
2
  allProducts(
3
    filter: {
4
      _firstPublishedAt: {
5
        gt: "2018-02-13T14:30:00+00:00"
6
      }
7
    }
8
  ) {
9
    title
10
  }
11
}

Filter records with a value that's less than the one specified. Seconds and milliseconds are truncated from the argument.

1
query {
2
  allProducts(
3
    filter: {
4
      _firstPublishedAt: {
5
        lt: "2018-02-13T14:30:00+00:00"
6
      }
7
    }
8
  ) {
9
    title
10
  }
11
}

Filter records with a value that's greater than or equal to than the one specified. Seconds and milliseconds are truncated from the argument.

1
query {
2
  allProducts(
3
    filter: {
4
      _firstPublishedAt: {
5
        gte: "2018-02-13T14:30:00+00:00"
6
      }
7
    }
8
  ) {
9
    title
10
  }
11
}

Filter records with a value that's less or equal than the one specified. Seconds and milliseconds are truncated from the argument.

1
query {
2
  allProducts(
3
    filter: {
4
      _firstPublishedAt: {
5
        lte: "2018-02-13T14:30:00+00:00"
6
      }
7
    }
8
  ) {
9
    title
10
  }
11
}

Filter records with a value that's within the specified minute range. Seconds and milliseconds are truncated from the argument.

1
query {
2
  allProducts(
3
    filter: {
4
      _firstPublishedAt: {
5
        eq: "2018-02-13T14:30:00+00:00"
6
      }
7
    }
8
  ) {
9
    title
10
  }
11
}

Filter records with a value that's outside the specified minute range. Seconds and milliseconds are truncated from the argument.

1
query {
2
  allProducts(
3
    filter: {
4
      _firstPublishedAt: {
5
        neq: "2018-02-13T14:30:00+00:00"
6
      }
7
    }
8
  ) {
9
    title
10
  }
11
}

Filter records with the specified field defined (i.e. with any value) or not

1
query {
2
  allProducts(filter: { _firstPublishedAt: { exists: true } }) {
3
    title
4
  }
5
}

Filter by `_isValid` meta field

Search for records with an exact match

1
query {
2
  allProducts(filter: { _isValid: { eq: true } }) {
3
    title
4
  }
5
}

Filter by `_publicationScheduledAt` meta field

Filter records with a value that's strictly greater than the one specified. Seconds and milliseconds are truncated from the argument.

1
query {
2
  allProducts(
3
    filter: {
4
      _publicationScheduledAt: {
5
        gt: "2018-02-13T14:30:00+00:00"
6
      }
7
    }
8
  ) {
9
    title
10
  }
11
}

Filter records with a value that's less than the one specified. Seconds and milliseconds are truncated from the argument.

1
query {
2
  allProducts(
3
    filter: {
4
      _publicationScheduledAt: {
5
        lt: "2018-02-13T14:30:00+00:00"
6
      }
7
    }
8
  ) {
9
    title
10
  }
11
}

Filter records with a value that's greater than or equal to than the one specified. Seconds and milliseconds are truncated from the argument.

1
query {
2
  allProducts(
3
    filter: {
4
      _publicationScheduledAt: {
5
        gte: "2018-02-13T14:30:00+00:00"
6
      }
7
    }
8
  ) {
9
    title
10
  }
11
}

Filter records with a value that's less or equal than the one specified. Seconds and milliseconds are truncated from the argument.

1
query {
2
  allProducts(
3
    filter: {
4
      _publicationScheduledAt: {
5
        lte: "2018-02-13T14:30:00+00:00"
6
      }
7
    }
8
  ) {
9
    title
10
  }
11
}

Filter records with a value that's within the specified minute range. Seconds and milliseconds are truncated from the argument.

1
query {
2
  allProducts(
3
    filter: {
4
      _publicationScheduledAt: {
5
        eq: "2018-02-13T14:30:00+00:00"
6
      }
7
    }
8
  ) {
9
    title
10
  }
11
}

Filter records with a value that's outside the specified minute range. Seconds and milliseconds are truncated from the argument.

1
query {
2
  allProducts(
3
    filter: {
4
      _publicationScheduledAt: {
5
        neq: "2018-02-13T14:30:00+00:00"
6
      }
7
    }
8
  ) {
9
    title
10
  }
11
}

Filter records with the specified field defined (i.e. with any value) or not

1
query {
2
  allProducts(filter: { _publicationScheduledAt: { exists: true } }) {
3
    title
4
  }
5
}

Filter by `_publishedAt` meta field

Filter records with a value that's strictly greater than the one specified. Seconds and milliseconds are truncated from the argument.

1
query {
2
  allProducts(
3
    filter: {
4
      _publishedAt: {
5
        gt: "2018-02-13T14:30:00+00:00"
6
      }
7
    }
8
  ) {
9
    title
10
  }
11
}

Filter records with a value that's less than the one specified. Seconds and milliseconds are truncated from the argument.

1
query {
2
  allProducts(
3
    filter: {
4
      _publishedAt: {
5
        lt: "2018-02-13T14:30:00+00:00"
6
      }
7
    }
8
  ) {
9
    title
10
  }
11
}

Filter records with a value that's greater than or equal to than the one specified. Seconds and milliseconds are truncated from the argument.

1
query {
2
  allProducts(
3
    filter: {
4
      _publishedAt: {
5
        gte: "2018-02-13T14:30:00+00:00"
6
      }
7
    }
8
  ) {
9
    title
10
  }
11
}

Filter records with a value that's less or equal than the one specified. Seconds and milliseconds are truncated from the argument.

1
query {
2
  allProducts(
3
    filter: {
4
      _publishedAt: {
5
        lte: "2018-02-13T14:30:00+00:00"
6
      }
7
    }
8
  ) {
9
    title
10
  }
11
}

Filter records with a value that's within the specified minute range. Seconds and milliseconds are truncated from the argument.

1
query {
2
  allProducts(
3
    filter: {
4
      _publishedAt: {
5
        eq: "2018-02-13T14:30:00+00:00"
6
      }
7
    }
8
  ) {
9
    title
10
  }
11
}

Filter records with a value that's outside the specified minute range. Seconds and milliseconds are truncated from the argument.

1
query {
2
  allProducts(
3
    filter: {
4
      _publishedAt: {
5
        neq: "2018-02-13T14:30:00+00:00"
6
      }
7
    }
8
  ) {
9
    title
10
  }
11
}

Filter records with the specified field defined (i.e. with any value) or not

1
query {
2
  allProducts(filter: { _publishedAt: { exists: true } }) {
3
    title
4
  }
5
}

Filter by `_status` meta field

Search the record with the specified status

1
query {
2
  allProducts(filter: { _status: { eq: draft } }) {
3
    title
4
  }
5
}

Exclude the record with the specified status

1
query {
2
  allProducts(filter: { _status: { neq: draft } }) {
3
    title
4
  }
5
}

Search records with the specified statuses

1
query {
2
  allProducts(filter: { _status: { in: [draft] } }) {
3
    title
4
  }
5
}

Search records without the specified statuses

1
query {
2
  allProducts(filter: { _status: { notIn: [draft] } }) {
3
    title
4
  }
5
}

Filter by `_unpublishingScheduledAt` meta field

Filter records with a value that's strictly greater than the one specified. Seconds and milliseconds are truncated from the argument.

1
query {
2
  allProducts(
3
    filter: {
4
      _unpublishingScheduledAt: {
5
        gt: "2018-02-13T14:30:00+00:00"
6
      }
7
    }
8
  ) {
9
    title
10
  }
11
}

Filter records with a value that's less than the one specified. Seconds and milliseconds are truncated from the argument.

1
query {
2
  allProducts(
3
    filter: {
4
      _unpublishingScheduledAt: {
5
        lt: "2018-02-13T14:30:00+00:00"
6
      }
7
    }
8
  ) {
9
    title
10
  }
11
}

Filter records with a value that's greater than or equal to than the one specified. Seconds and milliseconds are truncated from the argument.

1
query {
2
  allProducts(
3
    filter: {
4
      _unpublishingScheduledAt: {
5
        gte: "2018-02-13T14:30:00+00:00"
6
      }
7
    }
8
  ) {
9
    title
10
  }
11
}

Filter records with a value that's less or equal than the one specified. Seconds and milliseconds are truncated from the argument.

1
query {
2
  allProducts(
3
    filter: {
4
      _unpublishingScheduledAt: {
5
        lte: "2018-02-13T14:30:00+00:00"
6
      }
7
    }
8
  ) {
9
    title
10
  }
11
}

Filter records with a value that's within the specified minute range. Seconds and milliseconds are truncated from the argument.

1
query {
2
  allProducts(
3
    filter: {
4
      _unpublishingScheduledAt: {
5
        eq: "2018-02-13T14:30:00+00:00"
6
      }
7
    }
8
  ) {
9
    title
10
  }
11
}

Filter records with a value that's outside the specified minute range. Seconds and milliseconds are truncated from the argument.

1
query {
2
  allProducts(
3
    filter: {
4
      _unpublishingScheduledAt: {
5
        neq: "2018-02-13T14:30:00+00:00"
6
      }
7
    }
8
  ) {
9
    title
10
  }
11
}

Filter records with the specified field defined (i.e. with any value) or not

1
query {
2
  allProducts(filter: { _unpublishingScheduledAt: { exists: true } }) {
3
    title
4
  }
5
}

Filter by `_updatedAt` meta field

Filter records with a value that's strictly greater than the one specified. Seconds and milliseconds are truncated from the argument.

1
query {
2
  allProducts(
3
    filter: {
4
      _updatedAt: {
5
        gt: "2018-02-13T14:30:00+00:00"
6
      }
7
    }
8
  ) {
9
    title
10
  }
11
}

Filter records with a value that's less than the one specified. Seconds and milliseconds are truncated from the argument.

1
query {
2
  allProducts(
3
    filter: {
4
      _updatedAt: {
5
        lt: "2018-02-13T14:30:00+00:00"
6
      }
7
    }
8
  ) {
9
    title
10
  }
11
}

Filter records with a value that's greater than or equal to than the one specified. Seconds and milliseconds are truncated from the argument.

1
query {
2
  allProducts(
3
    filter: {
4
      _updatedAt: {
5
        gte: "2018-02-13T14:30:00+00:00"
6
      }
7
    }
8
  ) {
9
    title
10
  }
11
}

Filter records with a value that's less or equal than the one specified. Seconds and milliseconds are truncated from the argument.

1
query {
2
  allProducts(
3
    filter: {
4
      _updatedAt: {
5
        lte: "2018-02-13T14:30:00+00:00"
6
      }
7
    }
8
  ) {
9
    title
10
  }
11
}

Filter records with a value that's within the specified minute range. Seconds and milliseconds are truncated from the argument.

1
query {
2
  allProducts(
3
    filter: {
4
      _updatedAt: {
5
        eq: "2018-02-13T14:30:00+00:00"
6
      }
7
    }
8
  ) {
9
    title
10
  }
11
}

Filter records with a value that's outside the specified minute range. Seconds and milliseconds are truncated from the argument.

1
query {
2
  allProducts(
3
    filter: {
4
      _updatedAt: {
5
        neq: "2018-02-13T14:30:00+00:00"
6
      }
7
    }
8
  ) {
9
    title
10
  }
11
}

Filter records with the specified field defined (i.e. with any value) or not

1
query {
2
  allProducts(filter: { _updatedAt: { exists: true } }) {
3
    title
4
  }
5
}

Filter by `id` meta field

Search the record with the specified ID

1
query {
2
  allProducts(filter: { id: { eq: "123" } }) {
3
    title
4
  }
5
}

Exclude the record with the specified ID

1
query {
2
  allProducts(filter: { id: { neq: "123" } }) {
3
    title
4
  }
5
}

Search records with the specified IDs

1
query {
2
  allProducts(filter: { id: { in: ["123"] } }) {
3
    title
4
  }
5
}

Search records that do not have the specified IDs

1
query {
2
  allProducts(filter: { id: { notIn: ["123"] } }) {
3
    title
4
  }
5
}

Filter by `parent` meta field

Filter records children of the specified record. Value must be a Record ID

1
query {
2
  allProducts(filter: { parent: { eq: "123" } }) {
3
    title
4
  }
5
}

Filter records with a parent record or not

1
query {
2
  allProducts(filter: { parent: { exists: true } }) {
3
    title
4
  }
5
}

Filter by `position` meta field

Filter records with a value that's strictly greater than the one specified

1
query {
2
  allProducts(filter: { position: { gt: 3 } }) {
3
    title
4
  }
5
}

Filter records with a value that's less than the one specified

1
query {
2
  allProducts(filter: { position: { lt: 3 } }) {
3
    title
4
  }
5
}

Filter records with a value that's greater than or equal to the one specified

1
query {
2
  allProducts(filter: { position: { gte: 3 } }) {
3
    title
4
  }
5
}

Filter records with a value that's less or equal than the one specified

1
query {
2
  allProducts(filter: { position: { lte: 3 } }) {
3
    title
4
  }
5
}

Search for records with an exact match

1
query {
2
  allProducts(filter: { position: { eq: 3 } }) {
3
    title
4
  }
5
}

Exclude records with an exact match

1
query {
2
  allProducts(filter: { position: { neq: 3 } }) {
3
    title
4
  }
5
}

Did this doc help you?

Need help?

Explore our forum, contact support, or connect with our sales team . You can also chat live with other users in our Slack channel.

Content Delivery API > Filtering records

Filters available for field types

Boolean fields

Color fields

Date fields

DateTime fields

Single file fields

Floating-point number fields

Multiple files fields

Integer number fields

JSON fields

Geolocation fields

Single link fields

Multiple links fields

SEO meta tags fields

Slug fields

Single-line string fields

Structured text fields

Multiple-paragraph text fields

Video fields

Filters available for meta fields

Filter by _createdAt meta field

Filter by _firstPublishedAt meta field

Filter by _isValid meta field

Filter by _publicationScheduledAt meta field

Filter by _publishedAt meta field

Filter by _status meta field

Filter by _unpublishingScheduledAt meta field

Filter by _updatedAt meta field

Filter by id meta field

Filter by parent meta field

Filter by position meta field

Filter by `_createdAt` meta field

Filter by `_firstPublishedAt` meta field

Filter by `_isValid` meta field

Filter by `_publicationScheduledAt` meta field

Filter by `_publishedAt` meta field

Filter by `_status` meta field

Filter by `_unpublishingScheduledAt` meta field

Filter by `_updatedAt` meta field

Filter by `id` meta field

Filter by `parent` meta field

Filter by `position` meta field