Skip to main content

Generated API - Filtering

The generated API comes with inbuilt support for filtering.

Filtering uses the where parameter to define filters. It can be used to filter on record properties (such as a user's email address) or related record properties (such as a user's top 10 most recent post titles).

note

The where parameter is available only on endpoints and queries that return a list of items. For example /api/posts /api/posts/{id}/tags

Filter conditions and operators​

The where parameter supports the following operators:

  • lt
  • lte
  • gt
  • contains
  • startsWith
  • endsWith
  • mode
  • not
note

The Searchable flag in the entity field settings determines whether the record can be included in a search. The flag is activated by default.

To find out more about filters and operators, we recommend reading the Prisma Client API reference

Filtering Examples​

The following example gets all posts where the title includes the text “Node.js”

REST API​

curl -X 'GET' \
  'https://[server-url]/api/posts?where%5Btitle%5D[contains]=Node.js' \
  -H 'accept: application/json'

GraphQL​

query{
  posts(
    where:{
      title:{
        contains:"Node.js"
      }
    }
  ){
    id
    title
  }
}