---
title: Filter JSON Objects from a JSON List
slug: filter-json-objects-from-a-json-list
docTags: 
createdAt: 2021-12-22T07:28:32.000Z
---

Filters the matched JSON objects and returns a JSON Object List with only the once that matched the criteria 



| Processing Rule            | Possible values     | Description                                                               | Default  |
| -------------------------- | ------------------- | ------------------------------------------------------------------------- | -------- |
| **match\_type**            | text/date/number    | Filter rules/matches are processed based on the given types               | text     |
| **match\_operator**        |                     | The match comparison rule is different match type                         |          |
| -- for match\_type\:text   | equals              | Exact match                                                               | contains |
|                            | contains            | Matches the match pattern anywhere within key                             |          |
|                            | does-not-contain    | Matches if the match pattern is not present within the key                |          |
|                            | is-null             | Matches if the key is not present or has an empty string or value is null |          |
|                            | is-not-null         | Matches if the key is present                                             |          |
| -- for match\_type: date   | equals              | Exact Match                                                               | equals   |
|                            | greater-than        | Matches if the date in key is greater than date in match                  |          |
|                            | lesser-than         | Matches if the date in key is lesser than date in match                   |          |
|                            | greater-than-equals | Matches if the date in key is greater than or equal to date in match      |          |
|                            | lesser-than-equals  | Matches if the date in key is lesser than or equal to date in match       |          |
| -- for match\_type: number | equals              | Exact Match                                                               | equals   |
|                            | greater-than        | Matches if the number in key is greater than number in match              |          |
|                            | lesser-than         | Matches if the numbert in key is lesser than number in match              |          |
|                            | greater-than-equals | Matches if the number in key is lesser than or equal to number in match   |          |
|                            | lesser-than-euals   | Matches if the number in key is lesser than or equal to number in match   |          |
|                            |                     |                                                                           |          |



### API Definition

:::ApiMethodV2
```json
{
  "tab": "examples",
  "url": "https://orca.pathfix.com/functions/list/filter",
  "name": "Filter JSON Objects from JSON List API",
  "method": "POST",
  "request": {
    "pathParameters": [],
    "queryParameters": [],
    "headerParameters": [],
    "bodyDataParameters": [],
    "formDataParameters": []
  },
  "results": {
    "languages": [
      {
        "id": "28UsDqyeH3QRdmtVamSQT",
        "code": "{\n    \"output\": [\n        {\n            \"name\": \"Langley\"\n        }\n    ]\n}",
        "language": "200"
      },
      {
        "id": "yIX64DyIuDPJgBRFSfAWb",
        "code": "{\n    \"message\": \"error\"\n}",
        "language": "404"
      }
    ],
    "selectedLanguageId": "28UsDqyeH3QRdmtVamSQT"
  },
  "examples": {
    "languages": [
      {
        "id": "ENcJz9TStG38F0X-taA4x",
        "code": "{\r\n\t\"input\": [{\r\n\t\t\"name\": \"Jason\"\r\n\t}, {\r\n\t\t\"name\": \"Langley\"\r\n\t}],\r\n\t\"key\": \"name\",\r\n\t\"match\": \"Langley\"\r\n}",
        "language": "json"
      }
    ],
    "selectedLanguageId": "ENcJz9TStG38F0X-taA4x"
  },
  "description": "\nCall the following API:",
  "currentNewParameter": {
    "label": "Body Parameter",
    "value": "bodyDataParameters"
  }
}
```
:::