Query files and folders by metadata using SQL-like syntax. Returns items that have metadata instances matching the specified template and optional query conditions. Use this action when you need to find files/folders based on their metadata values rather than searching by file n…
fromRequiredstringThe metadata template to query. Must be in the form 'scope.templateKey'. For enterprise templates, use 'enterprise_XXXXX.templateKey' where XXXXX is your enterprise ID. For example: 'enterprise_1351007304.contractTemplate'. Note: Box-provided classification templates cannot be u…
limitintegerA value between 0 and 100 that indicates the maximum number of results to return for a single request. This only specifies a maximum boundary and will not guarantee the minimum number of results returned.
querystringOptional SQL-like filter expression to match metadata field values. Use parameterized values with ':' prefix (e.g., ':value') that map to query_params. Examples: 'status = :val', 'amount >= :min AND amount <= :max', 'category LIKE :pattern'. Supported operators: =, <, >, <=, >=,…
fieldsarrayBy default, this endpoint returns only the most basic info about the items for which the query matches. This attribute can be used to specify a list of additional attributes to return for any item, including its metadata. This attribute takes a list of item fields, metadata temp…
markerstringPagination marker from a previous response's 'next_marker' field. Use this to retrieve the next page of results when the previous response included a next_marker.
order_byarrayA list of template fields and directions to sort the metadata query results by. The ordering `direction` must be the same for each item in the array.
query_paramsobjectKey-value pairs for parameterized values used in the 'query' expression. Keys must match the parameter names in query (without ':'). Example: if query='status = :val', then query_params={'val': 'approved'}. Value types must match the metadata template field types (string, float,…
ancestor_folder_idRequiredstringThe folder ID to search within. Use '0' to search all folders accessible to the user. Use a specific folder ID to limit results to that folder and its subfolders. Example: '0' for root/all folders, or '12345' for a specific folder.
dataRequiredData from the action execution
errorstringError if any occurred during the execution of the action
successfulRequiredbooleanWhether or not the action execution was successful or not
OAuth connection. Risk level 2 of 5.
Free Action
No published Skills explicitly reference this Action yet.