Search filters

Our integration APIs support OData filters. Search filters are an essential part of allowing you to refine your query results to meet your specific needs.

QUERY

Parameter	Description	Type	Required
$count	Returns the total number of items matching the query.	boolean	No
$skip	Skips the first n rows of results.	integer	No
$top	Returns only the first n rows of results.	integer	No
$select	Selects only the specified fields in the results.	string	No
$orderby	Sorts the results based on one or more fields.	string	No
$filter	Filters results based on a condition.	string	No

Identify which filters are most relevant to your query based on your specific needs.

When making a call, add the desired filters to the request parameters. The API will return results based on the applied filters.

Request example

Search for a list of printers with the following specifications:

• Include the total count of available printers that meet the query criteria (count=true).
• Skip the first result (skip=1).
• Return the next 3 results (top=3).
• Return only the id, displayName, and agent fields (select=id%2CdisplayName%2Cagent).
• Sort the results by the displayName field in descending order (orderby=displayName%20desc).
• Return products that do not contain the displayName (filter=displayName%20ne%20%27ABC%27)

curl -L -X GET '/v1/printers?%24count=true&%24skip=1&%24top=3&%24select=id%2CdisplayName%2Cagent&%24orderby=displayName%20desc&%24filter=displayName%20ne%20%27ABC%27' \
-H ‘Authorization: Bearer <token>’ \
-H ‘Tenant: <tenant>’ \
-H ‘Accept: application/json’ \
-d ‘’

Response example

The response code 200 indicates that the search was performed successfully and will return the JSON with the data searched according to the chosen filters:

{
    "items": [
        { 
            "id": "123",
            "displayName": "ZYX",
            "agent": "NDD - Printer Monitor"
        },
        {
            "id": "456",
            "displayName": "WVT",
            "agent": "NDD - Printer Monitor"
        },
        {
            "id": "789",
            "displayName": "SRQ",
            "agent": "NDD - Printer Monitor"
        }
    ],
    "count": 27
}