Invalid Query Parameter

← Back to Overview

This error occurs when a client attempts to query or filter a collection using invalid parameters, unknown property names, or unsupported filter operators in the URL query string.

---

Error Response Example (RFC 9457)

{
  "type": "https://docs.apinow.app/errors/invalid-query-param",
  "title": "Invalid Query Parameter",
  "status": 400,
  "code": "INVALID_QUERY_PARAM",
  "detail": "The property 'nonexistent' is not allowed for filtering on entity 'Post'.",
  "instance": "/api/v1/posts?nonexistent=eq:test"
}

---

Troubleshooting Guide

For API Consumers (What it means & how to fix)

• Unknown Filter Properties: Double-check the schema of the resource you are querying. Ensure you are only filtering, sorting, or searching by properties that actually exist on the entity.
• Malformed Operators: Verify that your query syntax is correct. Filters must follow the format property=operator:value (e.g., age=gte:18 or status=eq:active).
• Invalid Sort Syntax: Sort queries must use the allowed syntax (e.g. sort=createdAt:desc).

For API Authors (Domain & API Modeler notes)

• Filtering & Sorting Exposures: In the API Modeler, check which properties are allowed to be filtered or sorted for the exposed collection. If a client needs to filter by a property, make sure it is checked in the “Allow Filtering” list.