Filtering and sorting

Overview

Filtering and sorting enable clients to refine API responses by applying structured query conditions and ordering rules.

These capabilities are supported across multiple API resources, including certificates, domains, organizations, discovery tasks, and administrative entities.

Note:
Each API endpoint documents which field names are valid for filtering and sorting in the API reference.
Check the endpoint's parameter documentation for the list of supported fields.

Filtering

Legacy filtering (DTO-based)

V1 API endpoints (for example /api/ssl/v1, /api/smime/v1) accept filters as individual query parameters.
Each filterable field is a separate query parameter documented in the endpoint's parameter table.

Example:

GET /api/ssl/v1?size=20&position=0&commonName=example.com&status=Issued

Expression-based filtering

Most of the latest API endpoint versions use a repeatable filter query parameter with the following syntax:

filter=<field><operation><value>

By default, multiple filter parameters are combined with AND logic.

Example:

GET /api/mark-certificate/v1?filter=status%3DIssued&filter=commonName%3Fexample&size=20&page=0

Filter operations

Symbol	Name	Applicable filter types	URL-encoded
`?`	LIKE (contains)	text	`%3F`
`!?`	NOT LIKE	text	`!%3F`
`=`	EQUAL	text, numeric, enum, date, boolean	`%3D`
`!=`	NOT EQUAL	text, numeric, enum, date, boolean	`!%3D`
`>`	GREATER THAN	date	`%3E`
`>=`	GREATER OR EQUAL	date	`%3E%3D`
`<`	LESS THAN	date	`%3C`
`<=`	LESS OR EQUAL	date	`%3C%3D`
`~`	REGEXP	text	`~`
`^`	STARTS WITH	text	`%5E`
`_`	ENDS WITH	text	`_`

Note:
Operation symbols that conflict with URL-reserved characters (?, =, >, <, ^) must be URL-encoded when sent in a query string.

Supported field types

Type	Description	Example
text	String fields. It supports LIKE, REGEXP, STARTS/ENDS WITH	`commonName?example`
numeric	Integer fields. It supports EQUAL (comma-separated list for IN)	`personId=5`
enum	Enumerated values. It supports EQUAL or NOT EQUAL	`status=Issued`
date	Date/time fields. It supports comparison operators. Absolute values use `yyyy-MM-dd`; Relative values use `<n>[dhms]` and are supported only with `<` (LAST) and `>` (NEXT)	`expires>2025-01-01`
dualState	true/false fields. It supports only the EQUAL operation.	`enabled=true`
org	Numeric organization ID fields. May contain optional Y/N flag that allows to include or exclude departments when filtering the list as the second value after comma. Default behavior is to include departments. It supports only the EQUAL operation.	`orgId=5,N`

Sorting

Endpoints using expression-based filtering accept a sort query parameter.

Example:

sort=<field>,asc

sort=<field>,desc