> For the complete documentation index, see [llms.txt](https://docs.truedat.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.truedat.io/v8.8/api-integrations/data-catalog-data-lineage-and-grants-apis/data-structure-filters.md).

# Data Structure Filters

## List data structure filters

> Returns available data structure filters based on the caller's permissions and provided parameters.

```json
{"openapi":"3.0.0","info":{"title":"td-dd","version":"Truedat 8.8.2"},"paths":{"/api/data_structure_filters":{"get":{"description":"Returns available data structure filters based on the caller's permissions and provided parameters.","operationId":"TdDdWeb.DataStructureFilterController.index","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataStructureFiltersResponse"}}},"description":"Data structure filters"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TdDdUnauthorizedResponse"}}},"description":"Unauthorized"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TdDdInternalServerErrorResponse"}}},"description":"Internal Server Error"}},"summary":"List data structure filters","tags":["Data Structure Filters"]}}},"components":{"schemas":{"DataStructureFiltersResponse":{"properties":{"data":{"additionalProperties":true,"type":"object"}},"title":"DataStructureFiltersResponse","type":"object"},"TdDdUnauthorizedResponse":{"anyOf":[{"$ref":"#/components/schemas/TdDdUnauthorizedMessageResponse"},{"$ref":"#/components/schemas/TdDdUnauthorizedErrorResponse"}],"description":"Unauthorized response from auth plug or error view","title":"TdDdUnauthorizedResponse"},"TdDdUnauthorizedMessageResponse":{"additionalProperties":false,"properties":{"message":{"type":"string"}},"required":["message"],"title":"TdDdUnauthorizedMessageResponse","type":"object"},"TdDdUnauthorizedErrorResponse":{"properties":{"errors":{"properties":{"detail":{"type":"string"}},"type":"object"}},"required":["errors"],"title":"TdDdUnauthorizedErrorResponse","type":"object"},"TdDdInternalServerErrorResponse":{"additionalProperties":false,"properties":{"errors":{"additionalProperties":false,"properties":{"detail":{"type":"string"}},"required":["detail"],"type":"object"}},"required":["errors"],"title":"TdDdInternalServerErrorResponse","type":"object"}}}}
```

## Get bucket paths

> Retrieves bucket paths for the given filters using the caller's permissions.

```json
{"openapi":"3.0.0","info":{"title":"td-dd","version":"Truedat 8.8.2"},"paths":{"/api/buckets/paths":{"post":{"description":"Retrieves bucket paths for the given filters using the caller's permissions.","operationId":"TdDdWeb.DataStructureFilterController.get_bucket_paths","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BucketPathsRequest"}}},"description":"Bucket paths payload","required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BucketPathsResponse"}}},"description":"Bucket paths response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TdDdUnauthorizedResponse"}}},"description":"Unauthorized"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TdDdInternalServerErrorResponse"}}},"description":"Internal Server Error"}},"summary":"Get bucket paths","tags":["Data Structure Filters"]}}},"components":{"schemas":{"BucketPathsRequest":{"additionalProperties":true,"properties":{"bucket":{"description":"Bucket name","type":"string"},"prefix":{"description":"Prefix to filter paths","type":"string"}},"title":"BucketPathsRequest","type":"object"},"BucketPathsResponse":{"properties":{"filtered_children":{"additionalProperties":{"items":{"type":"integer"},"type":"array"},"description":"Map of parent ID to list of child IDs that have filtered descendants","type":"object"},"forest":{"additionalProperties":{"additionalProperties":true,"type":"object"},"description":"Hierarchical tree of data structure IDs","type":"object"}},"required":["forest","filtered_children"],"title":"BucketPathsResponse","type":"object"},"TdDdUnauthorizedResponse":{"anyOf":[{"$ref":"#/components/schemas/TdDdUnauthorizedMessageResponse"},{"$ref":"#/components/schemas/TdDdUnauthorizedErrorResponse"}],"description":"Unauthorized response from auth plug or error view","title":"TdDdUnauthorizedResponse"},"TdDdUnauthorizedMessageResponse":{"additionalProperties":false,"properties":{"message":{"type":"string"}},"required":["message"],"title":"TdDdUnauthorizedMessageResponse","type":"object"},"TdDdUnauthorizedErrorResponse":{"properties":{"errors":{"properties":{"detail":{"type":"string"}},"type":"object"}},"required":["errors"],"title":"TdDdUnauthorizedErrorResponse","type":"object"},"TdDdInternalServerErrorResponse":{"additionalProperties":false,"properties":{"errors":{"additionalProperties":false,"properties":{"detail":{"type":"string"}},"required":["detail"],"type":"object"}},"required":["errors"],"title":"TdDdInternalServerErrorResponse","type":"object"}}}}
```

## Search data structure filters

> Searches data structure filters using the provided filter payload and the caller's permissions.

```json
{"openapi":"3.0.0","info":{"title":"td-dd","version":"Truedat 8.8.2"},"paths":{"/api/data_structure_filters/search":{"post":{"description":"Searches data structure filters using the provided filter payload and the caller's permissions.","operationId":"TdDdWeb.DataStructureFilterController.search","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataStructureFilterSearchRequest"}}},"description":"Filter search payload","required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataStructureFiltersResponse"}}},"description":"Filtered results"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TdDdUnauthorizedResponse"}}},"description":"Unauthorized"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TdDdInternalServerErrorResponse"}}},"description":"Internal Server Error"}},"summary":"Search data structure filters","tags":["Data Structure Filters"]}}},"components":{"schemas":{"DataStructureFilterSearchRequest":{"additionalProperties":true,"properties":{"filters":{"additionalProperties":true,"description":"Exact filter criteria","type":"object"},"link_structures":{"description":"If true, filter by structures that can be linked","type":"boolean"},"my_grant_requests":{"description":"If true, filter by grant requests for current user","type":"boolean"},"page":{"default":0,"description":"Page number","type":"integer"},"query":{"description":"Full-text search query","type":"string"},"scroll":{"description":"Scroll timeout","type":"string"},"scroll_id":{"description":"Scroll ID for pagination","type":"string"},"size":{"default":50,"description":"Page size","type":"integer"}},"title":"DataStructureFilterSearchRequest","type":"object"},"DataStructureFiltersResponse":{"properties":{"data":{"additionalProperties":true,"type":"object"}},"title":"DataStructureFiltersResponse","type":"object"},"TdDdUnauthorizedResponse":{"anyOf":[{"$ref":"#/components/schemas/TdDdUnauthorizedMessageResponse"},{"$ref":"#/components/schemas/TdDdUnauthorizedErrorResponse"}],"description":"Unauthorized response from auth plug or error view","title":"TdDdUnauthorizedResponse"},"TdDdUnauthorizedMessageResponse":{"additionalProperties":false,"properties":{"message":{"type":"string"}},"required":["message"],"title":"TdDdUnauthorizedMessageResponse","type":"object"},"TdDdUnauthorizedErrorResponse":{"properties":{"errors":{"properties":{"detail":{"type":"string"}},"type":"object"}},"required":["errors"],"title":"TdDdUnauthorizedErrorResponse","type":"object"},"TdDdInternalServerErrorResponse":{"additionalProperties":false,"properties":{"errors":{"additionalProperties":false,"properties":{"detail":{"type":"string"}},"required":["detail"],"type":"object"}},"required":["errors"],"title":"TdDdInternalServerErrorResponse","type":"object"}}}}
```