{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown","redocly_category":"Guides","api_domain":"Cross API"},"seo":{"title":"Filter query parameter","description":"How to use the $filter query parameter in Sales Layer REST APIs.","keywords":["Sales Layer","REST API","OpenAPI","DAM API","Catalog API","product catalog API","image management API","API integration"],"lang":"en-US","meta":[{"name":"og:type","content":"website"},{"name":"og:site_name","content":"Sales Layer REST API Documentation"},{"name":"og:title","content":"Sales Layer REST API Documentation"},{"name":"og:description","content":"Complete REST API documentation for Sales Layer's DAM and Catalog APIs. Learn authentication, pagination, filtering, and integration patterns."},{"name":"twitter:card","content":"summary_large_image"},{"name":"twitter:site","content":"@saleslayer"},{"name":"twitter:title","content":"Sales Layer REST API Documentation"},{"name":"twitter:description","content":"Complete REST API documentation for Sales Layer's DAM and Catalog APIs. Learn authentication, pagination, filtering, and integration patterns."}],"llmstxt":{"hide":false,"title":"Sales Layer REST API Documentation","description":"Technical guides and OpenAPI references for Sales Layer DAM and Catalog REST APIs.","sections":[{"title":"Guides","description":"Static API guides for authentication, headers, query parameters, responses, rate limiting, and best practices.","includeFiles":["guides/**/*.md","changelog.md"],"excludeFiles":[]},{"title":"API Reference","description":"OpenAPI-based references and API overview pages for Sales Layer REST APIs.","includeFiles":["apis/**/*.md","apis/**/*.yaml"],"excludeFiles":[]},{"title":"Postman collections","description":"Importable Postman collection and environment instructions for testing Sales Layer REST APIs.","includeFiles":["postman/**/*.md"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"filter","__idx":0},"children":["Filter"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["$filter"]}," to narrow the resources returned by an API request."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The current OpenAPI specifications document ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["$filter"]}," for:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["DAM list operations, such as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /dam/image"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Catalog list and changelog operations, such as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /catalog/rest/Catalog/Products"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"syntax","__idx":1},"children":["Syntax"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"text","header":{"controls":{"copy":{}}},"source":"$filter=PROPERTY_NAME operator VALUE\n","lang":"text"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Example:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"GET https://api2.saleslayer.com/catalog/rest/Catalog/Products?$filter=contains(prod_title,'EC')\n","lang":"http"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"supported-expressions","__idx":2},"children":["Supported expressions"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Filtering can use comparison operators, logical operators, and string functions where supported by the endpoint."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Examples:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"text","header":{"controls":{"copy":{}}},"source":"prod_ref eq 'ABC-001'\ncontains(prod_title,'EC')\ncat_ref eq 'LPG' or cat_title eq 'Products'\n","lang":"text"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"supported-properties","__idx":3},"children":["Supported properties"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For Catalog resources, use metadata endpoints to confirm the fields available for filtering."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For DAM images, use the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/apis/dam-v2.0"},"children":["DAM endpoint reference"]}," for supported query fields and examples."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"limitations","__idx":4},"children":["Limitations"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Based on the migrated documentation and the current API descriptions:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Filters apply to the root resource being requested."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Filtering nested resource properties is not documented as supported."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Property names, operators, and value formats must match the resource metadata and API reference."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"example-with-select","__idx":5},"children":["Example with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["$select"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"GET https://api2.saleslayer.com/catalog/rest/Catalog/Products?$select=prod_ref,prod_title&$filter=contains(prod_title,'EC')\n","lang":"http"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"notes","__idx":6},"children":["Notes"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Use URL encoding when filter values contain spaces, quotes, or special characters."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Combine multiple conditions with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["and"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["or"]}," when supported."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Test filters with small page sizes before running large synchronization jobs."]}]}]},"headings":[{"value":"Filter","id":"filter","depth":1},{"value":"Syntax","id":"syntax","depth":2},{"value":"Supported expressions","id":"supported-expressions","depth":2},{"value":"Supported properties","id":"supported-properties","depth":2},{"value":"Limitations","id":"limitations","depth":2},{"value":"Example with $select","id":"example-with-select","depth":2},{"value":"Notes","id":"notes","depth":2}],"frontmatter":{"seo":{"title":"Filter query parameter","description":"How to use the $filter query parameter in Sales Layer REST APIs."},"keywords":{"includes":["$filter","filtering","query parameters","Catalog API","DAM API"]},"metadata":{"redocly_category":"Guides","api_domain":"Cross API"}},"lastModified":"2026-06-03T15:57:05.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/guides/filter","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}