Filter users using a Base64-encoded JSON object.

Omit filters when you do not want to supply filter criteria.

Choose the fields below, serialize the object to JSON, and Base64-encode the UTF-8 bytes. Enter the encoded value in the filters input. These fields belong inside the JSON object; they are not separate query parameters.

Provide one or more properties to apply filters.

Decoded filter fields

Example before encoding

{
  "roles": [
    "Teacher"
  ]
}

Base64 value for the filters input

eyJyb2xlcyI6WyJUZWFjaGVyIl19

Example request

/users?filters=eyJyb2xlcyI6WyJUZWFjaGVyIl19

Encode inline in Node.js

const criteria = {"roles":["Teacher"]};
const params = new URLSearchParams({
  filters: Buffer.from(JSON.stringify(criteria), "utf8").toString("base64")
});
const path = "/users?" + params.toString();

Base64 encoding and URL encoding are separate steps. An HTTP client query-parameter helper can URL-encode the Base64 value for you. If constructing the URL manually, URL-encode the value once so +, /, and = are preserved.