> For the complete documentation index, see [llms.txt](https://developers.didomi.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developers.didomi.io/api-and-platform/introduction/filters.md).

# Filters

For `GET /` requests that list entities, the API generally allows using query-string parameters for filtering the returned entities.

The filters should be added as query-string parameters with their expected value. All fields that do not contain special query parameters are compared directly for equality.

For instance, you can get the entities for a specific organization ID by adding `organization_id={id}` in the query string:

```javascript
GET https://api.didomi.io/v1/widgets/notices/configs
    ?organization_id=didomi
```

The fields that can be used for filtering are the entity fields defined in our [API documentation](https://api.didomi.io/docs/).

{% hint style="danger" %}
Filtering is not supported on all routes. For instance, requests to `/consents/*` do not support filtering.
{% endhint %}


---

# 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://developers.didomi.io/api-and-platform/introduction/filters.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.
