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:

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.

Filtering is not supported on all routes. For instance, requests to /consents/* do not support filtering.

Last updated