magento · Schema

CustomerSearchResults

Paginated search results containing a list of customer accounts.

Properties

Name	Type	Description
items	array	Array of customer objects matching the search criteria.
search_criteria	object	The search criteria applied.
total_count	integer	Total number of matching customers across all pages.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CustomerSearchResults",
  "title": "CustomerSearchResults",
  "type": "object",
  "description": "Paginated search results containing a list of customer accounts.",
  "properties": {
    "items": {
      "type": "array",
      "description": "Array of customer objects matching the search criteria.",
      "items": {
        "$ref": "#/components/schemas/Customer"
      }
    },
    "search_criteria": {
      "type": "object",
      "description": "The search criteria applied."
    },
    "total_count": {
      "type": "integer",
      "description": "Total number of matching customers across all pages."
    }
  }
}