This is the documentation for 2022-02-01.

Batch-Endpoints

You can search within a collection using the filter-field.

URL Syntax

GET Method

GET /resources?filter[field]=value HTTP/1.1

Other Methods

POST, UPDATE, PATCH, DELETE /resources HTTP/1.1

Request

{
    "filter": {
        "field": "value",
        "nested.filter": "value"
    }
}

Not all attributes are searchable. You will see the actual filterable fields in the endpoint documentation.