> For the complete documentation index, see [llms.txt](https://dev.ubidots.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://dev.ubidots.com/sdks/javascript/ubidots-class/filter-methods.md). # Filter methods The Ubidots API supports requests that use [field filters](https://docs.ubidots.com/reference/field-filters), like this: ```bash GET https://industrial.api.ubidots.com/api/v2.0/devices/?label__startswith=temp ``` This library also provides a way to construct custom requests that use these filters. ## Filter methods
Filter methodDescriptionUsageArgumentsResponse
whereApplies a filter to a single property of the given entityUbidots.<entity>.where(<entity-property>).<filter>(<filter-value>).<get-method>([args])A valid property of the given entityDepends on the <getMethod> used.
addRawParamsApplies filters to multiple properties of the given entityUbidots.<entity>.addRawParams(<query-object>).<get-method>([args])

query-object: object An object containing query parameter-value pairs

{
  queryParam1: value1 
  ···    
  queryParamN: valueN
}
Depends on the <getMethod> used.
## Using the `where` method The example GET request at the top of this page can be reproduced with the library's `where` method: ```javascript const tempDevices = await Ubidots.devices.where('label').startsWith('temp').get(); ``` **Here:** * ` = devices` * ` = 'label'` * ` = startsWith` * ` = 'temp'` * ` = get` ## Using the `addRawParams` method The example GET request at the top of this page can be reproduced with the library's `addRawParams` method: ```javascript const filterParameters = { label__startswith: 'temp', }; const tempDevices = await Ubidots.devices.addRawParams(filterParameters).get(); ``` **Here:** * ` = devices` * ` = filterParameters` * ` = get` * ` = label__startswith` * ` = 'temp'` ## Accessing the filters [API filters](https://docs.ubidots.com/reference/field-filters) are written in snake case. For example, these [object filters](https://docs.ubidots.com/reference/json) are supported: * contains * contained\_by * has\_key To follow JavaScript's camel-case convention, the library's filters use camel case, so those same filters look like this: * contains * containedBy * hasKey Below is the full list of filters, showing the API names and their library equivalents. ### [ID](https://docs.ubidots.com/reference/id) | Filter in the API | Filter in the library | | :---------------: | :-------------------: | | exact ( = ) | `exact` | | in | `in` | ### [Boolean](https://docs.ubidots.com/reference/boolean) | Filter in the API | Filter in the library | | :---------------: | :-------------------: | | exact ( = ) | `is` | | isnull | `isNull` | ### [Number](https://docs.ubidots.com/reference/number) | Filter in the API | Filter in the library | | :---------------: | :-------------------: | | exact | `is` | | range | `range` | | gt ( > ) | `greaterThan` | | gte (`≥`) | `greaterThanEq` | | lt ( < ) | `lowerThan` | | lte (`≤`) | `lowerThanEq` | | isnull | `isNull` | ### [String](https://docs.ubidots.com/reference/string) | Filter in the API | Filter in the library | | :----------------------------: | :-------------------: | | exact ( = ) (case sensitive) | `exact` | | iexact (case sensitive) | `iexact` | | contains | `contains` | | icontains (case insensitive) | `iContains` | | startswith | `startsWith` | | istartswith (case insensitive) | `iStartsWith` | | endswith | `endsWith` | | iendswith (case insensitive) | `iEndsWith` | | in (case sensitive) | `in` | | isnull | `isNull` | ### [Array](https://docs.ubidots.com/reference/array) | Filter in the API | Filter in the library | | :---------------: | :-------------------: | | exact ( = ) | `exact` | | contains | `contains` | | contained\_by | `containedBy` | | overlap | `overlap` | | len | `len` | | isnull | `isNull` | ### [Object](https://docs.ubidots.com/reference/json) | Filter in the API | Filter in the library | | :---------------: | :-------------------: | | contains | `contains` | | contained\_by | `containedBy` | | has\_key | `hasKey` | | has\_any\_keys | `hasAnyKeys` | | has\_keys | `hasKeys` | | isnull | `isNull` | ### [Date](https://docs.ubidots.com/reference/date) | Filter in the API | Filter in the library | | :---------------: | :-------------------: | | exact ( = ) | `exact` | | date | `date` | | year | `year` | | quarter | `quarter` | | month | `month` | | week | `week` | | day | `day` | | hour | `hour` | | minute | `minute` | | second | `second` | | isnull | `isNull` | --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://dev.ubidots.com/sdks/javascript/ubidots-class/filter-methods.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.