Get Customer Filter Options
GET/api/magento2/integration-instances/:magento2IntegrationInstance/customers/filter-options
Aggregated dropdown options for the customers filter panel — countries (via the address rows), customer groups, and websites — each as {value, label, count} so the picker can render counts inline. Pulled live from the customers persisted for this instance; empty / never-synced instances surface empty lists.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
Request
Responses
- 200
- 401
- 403
- 404
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.