springimport / magento2-module-restapi-exclude-fields
REST API blacklist field filtering for Magento 2. Adds excludeFields parameter to exclude specified fields from API responses.
Installs: 38
Dependents: 0
Suggesters: 0
Security: 0
Stars: 2
Watchers: 1
Forks: 1
Open Issues: 0
Type:magento2-module
pkg:composer/springimport/magento2-module-restapi-exclude-fields
Requires
- php: ~7.2.0||~7.3.0||~7.4.0||~8.1.0||~8.2.0||~8.3.0
- magento/framework: >=102.0.0
Conflicts
This package is auto-updated.
Last update: 2026-01-01 21:42:53 UTC
README
Adds blacklist filtering to Magento REST API via excludeFields parameter. Magento has native whitelist filtering (?fields=), this module adds blacklist filtering (?excludeFields=) to exclude specified fields from responses.
Version Compatibility
| Magento Version | PHP Version | Status |
|---|---|---|
| 2.3.x - 2.4.x | 7.2 - 8.3 | ✅ Compatible |
| 2.2.x | 7.0 - 7.2 | ⚠️ Legacy (use v1.x) |
Installation
composer require springimport/magento2-module-restapi-exclude-fields:^2.0 php bin/magento module:enable SpringImport_RestApiExcludeFields php bin/magento setup:upgrade
Usage
GET /rest/V1/orders/1?excludeFields=items[product_option,extension_attributes]