Skip to main content
Some resources in the Directory API support a /_search endpoint, which allows for advanced filtering and querying.

​
Request

Search requests are sent as a POST request to: 
POST /:resource/_search
The request body must be a JSON object with a filter field that defines your query conditions.

​
JSON Structure

{
  "filter": {
    "orCondition": true,
    "nestedFilters": [],
    "equals": {},
    "notEquals": {},
    "greater": {},
    "smaller": {},
    "greaterOrEqual": {},
    "smallerOrEqual": {},
    "contains": {},
    "notContains": {},
    "like": {},
    "notLike": {},
    "null": {},
    "notNull": {}
  }
}

​
Filter Operators

OperatorDescriptionApplies To
equalsExact match on one or more fieldsAll field types
notEqualsNot equal to the given valueAll field types
greaterGreater than the given valueDate, Timestamp, Integer
smallerSmaller than the given valueDate, Timestamp, Integer
greaterOrEqualGreater than or equal to the given valueDate, Timestamp, Integer
smallerOrEqualSmaller than or equal to the given valueDate, Timestamp, Integer
containsField contains the valueString, Date, UUID, Enum, Array
notContainsField does not contain the valueString, Date, UUID, Enum, Array
likePartial string match (case-insensitive)String
notLikePartial string mismatchString
nullField must be nullNullable fields and arrays
notNullField must not be nullNullable fields and arrays

​
Logical Operators

  • orCondition:
    When true, filters at this level are combined using OR logic (any condition can match).
    When false or omitted, filters use AND logic (all conditions must match).
    This applies both at the root level and inside nestedFilters.
  • nestedFilters:
    A list of additional filter objects that are evaluated as a group, allowing for nested logic.
Note: Field names used in filters must match the exact field names defined in the resource schema (typically camelCase).

​
Example: Search Request

Find all StudentPlacements that are in schoolYear 7 and either:
  • have an endDate after 2025-04-24, or
  • have no endDate at all.
POST /student-placement/_search
Content-Type: application/json

{
  "filter": {
    "orCondition": false,
    "equals": {
      "schoolYear": "7"
    },
    "nestedFilters": [
      {
        "orCondition": true,
        "greater": {
          "endDate": "2025-04-24"
        },
        "null": {
          "endDate": true
        }
      }
    ]
  }
}

​
Equivalent SQL

SELECT * FROM student_placements WHERE school_year = '7' AND (end_date > '2025-04-24' OR end_date IS NULL);
This example helps illustrate how orCondition and nestedFilters map to grouped AND/OR conditions in SQL.