list_resources
Filter and retrieve catalog resources using structured queries, exact matches, and logical conditions. Supports pagination and sorting for precise results.
Instructions
List catalog resources with advanced filtering capabilities.
This endpoint provides precise control over resource queries using structured filters.
Use this when you need exact matching, specific field filtering, or complex queries.
Args:
filter: FilterOperand (field or logical) for filtering resources
sort: SortConfig for ordering results
page: Page number for pagination (default: 1)
truncate_length: Maximum characters for text fields in results (default: 150)
Returns:
Paginated list of resources matching the filter criteria
Filter Examples:
# Single condition - title contains
filter = {"operator": "contains", "field": "title", "value": "order_lines"}
# Single condition - entity type
filter = {"operator": "exact", "field": "native_type", "value": "table"}
# Find all columns of a specific table
filter = {"operator": "exact", "field": "parent_id", "value": "table-id-123"}
# Multiple conditions with AND
filter = {
"operator": "and",
"operands": [
{"operator": "exact", "field": "native_type", "value": "table"},
{"operator": "contains", "field": "title", "value": "customer"}
]
}
Sort Examples:
# Sort by title ascending
sort = {"field": "title", "order": "asc"}
# Sort by external_usage descending (most popular first)
sort = {"field": "external_usage", "order": "desc"}
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| filter | No | Filter dictionary for filtering resources. Can be either a field filter or logical filter. Field filter example: {"operator": "exact", "field": "title", "value": "my_table"} Logical filter example: {"operator": "and", "operands": [{"operator": "exact", "field": "native_type", "value": "table"}, {"operator": "contains", "field": "title", "value": "order"}]} PARENT/CHILD RELATIONSHIPS (COMMON PATTERN): - Filter by parent_id to find ALL columns of a table: {"operator": "exact", "field": "parent_id", "value": "table-id-123"} Available field operators: "exact", "contains", "in", "is_set" Available logical operators: "and", "or", "not" | |
| sort | No | Sort configuration dictionary for ordering results. Example: {"field": "title", "order": "asc"} With tie breaker: {"field": "updated_at", "order": "desc", "tie_breaker": {"field": "created_at", "order": "desc"}} | |
| page | No | Page number for pagination | |
| truncate_length | No | Maximum characters for text fields in results |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |