Stytch · Schema

api_user_v1_SearchUsersQuery

AuthenticationIdentityPasswordlessSecurityB2BConnected AppsMCPAI AgentsDeveloper Tools

Properties

Name	Type	Description
operator	object	The action to perform on the operands. The accepted values are: `AND` – all the operand values provided must match. `OR` – [DEPRECATED] the operator will return any matches to at least one of the
operands	array	An array of operand objects that contains all of the filters and values to apply to your search search query.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/api_user_v1_SearchUsersQuery",
  "title": "api_user_v1_SearchUsersQuery",
  "type": "object",
  "properties": {
    "operator": {
      "$ref": "#/components/schemas/api_user_v1_SearchUsersQueryOperator",
      "description": "The action to perform on the operands. The accepted values are:\n\n  `AND` \u2013 all the operand values provided must match.\n\n  `OR` \u2013 **[DEPRECATED]** the operator will return any matches to at least one of the operand values you supply. This parameter is retained for legacy use cases only and is no longer supported. We strongly recommend breaking down complex queries into multiple search queries instead."
    },
    "operands": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": true
      },
      "description": "An array of operand objects that contains all of the filters and values to apply to your search search query."
    }
  },
  "required": [
    "operator",
    "operands"
  ]
}