Query files/folders by metadata
For new integrations, use the v2026.0 Query API. This is the latest version of the Query API, with advanced capabilities including multi-template queries and Query Insights, and is the API we will continue to enhance with new Query capabilities.
Create a search using SQL-like syntax to return items that match specific metadata.
By default, this endpoint returns only the most basic info about the items for which the query matches. To get additional fields for each item, including any of the metadata, use the fields attribute in the query.
Authorizations
Body
Create a search using SQL-like syntax to return items that match specific metadata.
The query to perform. A query is a logical expression that is very similar to a SQL SELECT statement. Values in the search query can be turned into parameters specified in the query_param arguments list to prevent having to manually insert search values into the query string.
For example, a value of :amount would represent the amount value in query_params object.
"value >= :amount"
By 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 template identifiers, or metadata template field identifiers.
For example:
created_bywill add the details of the user who created the item to the response.metadata.<scope>.<templateKey>will return the mini-representation of the metadata instance identified by thescopeandtemplateKey.metadata.<scope>.<templateKey>.<field>will return all the mini-representation of the metadata instance identified by thescopeandtemplateKeyplus the field specified by thefieldname. Multiple fields for the samescopeandtemplateKeycan be defined.
Response
Returns a list of files and folders that match this metadata query.
A page of files and folders that matched the metadata query.
The mini representation of the files and folders that match the search terms.
By default, this endpoint returns only the most basic info about the items. To get additional fields for each item, including any of the metadata, use the fields attribute in the query.
A full representation of a file, as can be returned from any file API endpoints by default.
- File (Full)
- Folder (Full)
The marker for the start of the next page of results.
"0!-M7487OpVfBTNBV-XsQjU50gQFlbFFu5nArMWD7Ck61GH_Qo40M1S2xN5zWZPBzEjaQS1SOjJiQoo5BsXEl1bCVLRZ2pTqo4SKp9tyqzWQK2L51KR_nC1EgF5I_TJSFw7uO2Bx4HweGETOjh5_2oPSWw5iMkM-OvGApeR0lGFO48FDKoyzJyLgz5aogxoKd8VE09CesOOnTnmZvrW0puylDc-hFjY5YLmWFBKox3SOWiSDwKFkmZGNHyjEzza1nSwbZg6CYsAdGsDwGJhuCeTNsFzP5Mo5qx9wMloS0lSPuf2CcBInbIJzl2CKlXF3FvqhANttpm2nzdBTQRSoJyJnjVBpf4Q_HjV2eb4KIZBBlLy067UCVdv2AAWQFd5E2i6s1YiGRTtgMEZntOSUYD4IYLMWWm5Ra7ke_SP32SL3GSjbBQYIyCVQ.."
