> For the complete documentation index, see [llms.txt](https://docs.licensespring.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.licensespring.com/management-api/metadata-filtering.md).

# Metadata Filtering

To filter by object's metadata which is stored as JSON a query parameter with `metadata` prefix must be sent in the URL. Here are some examples of how this filtering works:

### Filter by whole metadata value

Query param: `metadata={"key1":"value1"}`

Response:

```json
[
    ...
    "metadata": {
        "key1": "value1"
    }
]
```

### Filter by string key value

Query param: `metadata__key1="value1"`

Response:

```json
[
    {
        ...
        "metadata": {
            "key1": "value1"
        }
    },
    {
        ...
        "metadata": {
            "key1": "value1",
            "key2": "value2"
        }
    }
]
```

### Filter by number key value

Query param: `metadata__key1=123`

Response:

```json
[
    {
        ...
        "metadata": {
            "key1": 123
        }
    }
]
```

### Filter by array key value

Query param: `metadata__key1=[1, 2, 3]`

Response:

```json
[
    {
        ...
        "metadata": {
            "key1": [
                1,
                2,
                3
            ]
        }
    }
]
```

### Filter by object key value

Query param: `metadata__key1={"key2": "value2"}`

Response:

```json
[
    {
        ...
        "metadata": {
            "key1": {
                "key2": "value2"
            }
        }
    }
]
```

### Filter by boolen key value

Query param: `metadata__key1=true`

Response:

```json
[
    {
        ...
        "metadata": {
            "key1": true
        }
    }
]
```

### Filter by null key value

Query param: `metadata__key1=null`

Response:

```json
[
    {
        ...
        "metadata": {
            "key1": null
        }
    }
]
```

### Filter by nested key value

Query param: `metadata__key1__key2__key3="value3"`

Response:

```json
[
    {
        ...
        "metadata": {
            "key1": {
                "key2": {
                    "key3": "value3"
                }
            }
        }
    }
]
```

### Filter by array item

Query param: `metadata__key1__0=1`

Response:

```json
[
    {
        ...
        "metadata": {
            "key1": [
                1,
                2,
                3
            ]
        }
    }
]
```

### Filter by array containing item

Query param: `metadata__key1__contains=1`

Response:

```json
[
    {
        "metadata": {
            "key1": [
                1,
                2,
                3
            ]
        }
    },
    {
        "metadata": {
            "key1": [
                3,
                2,
                1
            ]
        }
    }
]
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.licensespring.com/management-api/metadata-filtering.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.