Search Customers
GET/api/magento2/integration-instances/:magento2IntegrationInstance/customers/search
Search-as-you-type endpoint. Delegates to the same paginated query as List Customers (Spatie QueryBuilder under the hood) so every filter / sort / pagination param the index supports is also accepted here. Provided as a separate route so the frontend can wire a dedicated debounce path.
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.