CustomerPagedQueryResponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/commercetools/main/json-schema/commercetools-customer-paged-query-response-schema.json",
  "title": "CustomerPagedQueryResponse",
  "description": "Paginated response containing a list of customers.",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/commercetools-customers-api-openapi.yml#/components/schemas/CustomerPagedQueryResponse",
  "type": "object",
  "required": [
    "limit",
    "offset",
    "count",
    "total",
    "results"
  ],
  "properties": {
    "limit": {
      "type": "integer"
    },
    "offset": {
      "type": "integer"
    },
    "count": {
      "type": "integer"
    },
    "total": {
      "type": "integer"
    },
    "results": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/Customer"
      }
    }
  },
  "$defs": {
    "Address": {
      "type": "object",
      "description": "A postal address with country and optional structured fields.",
      "required": [
        "country"
      ],
      "properties": {
        "id": {
          "type": "string",
          "description": "Unique identifier for the address within the resource."
        },
        "key": {
          "type": "string",
          "description": "User-defined identifier for the address."
        },
        "country": {
          "type": "string",
          "description": "ISO 3166-1 alpha-2 country code."
        },
        "firstName": {
          "type": "string",
          "description": "First name of the address recipient."
        },
        "lastName": {
          "type": "string",
          "description": "Last name of the address recipient."
        },
        "streetName": {
          "type": "string",
          "description": "Street name component of the address."
        },
        "streetNumber": {
          "type": "string",
          "description": "Street number component of the address."
        },
        "city": {
          "type": "string",
          "description": "City of the address."
        },
        "postalCode": {
          "type": "string",
          "description": "Postal or ZIP code of the address."
        },
        "region": {
          "type": "string",
          "description": "Region, state, or province of the address."
        },
        "email": {
          "type": "string",
          "format": "email",
          "description": "Email address associated with this postal address."
        },
        "phone": {
          "type": "string",
          "description": "Phone number associated with this postal address."
        }
      }
    },
    "Customer": {
      "type": "object",
      "description": "A customer account with authentication credentials, addresses, and commerce profile data.",
      "required": [
        "id",
        "version",
        "email",
        "isEmailVerified",
        "addresses"
      ],
      "properties": {
        "id": {
          "type": "string",
          "description": "System-generated unique identifier."
        },
        "version": {
          "type": "integer",
          "description": "Current version for optimistic concurrency control."
        },
        "key": {
          "type": "string",
          "description": "User-defined unique identifier."
        },
        "email": {
          "type": "string",
          "format": "email",
          "description": "Customer email address, unique within the project or store."
        },
        "firstName": {
          "type": "string",
          "description": "Customer first name."
        },
        "lastName": {
          "type": "string",
          "description": "Customer last name."
        },
        "isEmailVerified": {
          "type": "boolean",
          "description": "Whether the customer email has been verified."
        },
        "customerGroup": {
          "$ref": "#/$defs/Reference"
        },
        "addresses": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/Address"
          },
          "description": "Saved addresses for the customer."
        },
        "stores": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/Reference"
          },
          "description": "Stores the customer is assigned to."
        },
        "createdAt": {
          "type": "string",
          "format": "date-time",
          "description": "ISO 8601 timestamp when the customer was created."
        },
        "lastModifiedAt": {
          "type": "string",
          "format": "date-time",
          "description": "ISO 8601 timestamp when the customer was last modified."
        }
      }
    },
    "Reference": {
      "type": "object",
      "description": "A reference to another resource by its typeId and id.",
      "required": [
        "typeId",
        "id"
      ],
      "properties": {
        "typeId": {
          "type": "string",
          "description": "The type identifier of the referenced resource (e.g., 'product', 'category')."
        },
        "id": {
          "type": "string",
          "description": "The system-generated unique identifier of the referenced resource."
        }
      }
    }
  }
}