Retrieve a list of customers

{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "_embedded": {
        "type": "array",
        "description": "Any embedded objects available that are requested by the `expand` querystring parameter.",
        "items": {
          "type": "object"
        }
      },
      "_links": {
        "type": "array",
        "description": "The links related to resource.",
        "items": {
          "type": "object"
        }
      },
      "averageValue": {
        "type": "object",
        "properties": {
          "amount": {
            "type": "number",
            "format": "double",
            "description": "Average approved payment amount in Merchant's reporting currency."
          },
          "amountUsd": {
            "type": "number",
            "format": "double",
            "description": "Average approved payment amount in USD."
          },
          "currency": {
            "description": "Merchant's reporting currency.",
            "type": "object"
          }
        }
      },
      "createdTime": {
        "description": "The customer created time.",
        "type": "object"
      },
      "customFields": {
        "type": "object",
        "description": "Custom Fields list as a map `{\"custom field name\": \"custom field value\", ...}`. The format must follow the saved format (see Custom Fields section for the formats).\n"
      },
      "defaultPaymentInstrument": {
        "type": "object"
      },
      "email": {
        "type": "string",
        "format": "email",
        "description": "The customer's email."
      },
      "firstName": {
        "type": "string",
        "description": "The customer's first name."
      },
      "id": {
        "description": "The customer identifier string.",
        "type": "object"
      },
      "invoiceCount": {
        "type": "integer",
        "description": "An auto-incrementing number based on the sequence of invoices. If set to 0, then this record is a Lead, otherwise is a Customer."
      },
      "lastName": {
        "type": "string",
        "description": "The customer's last name."
      },
      "lastPaymentTime": {
        "description": "The most recent time of an approved payment for the customer.",
        "type": "object"
      },
      "lifetimeRevenue": {
        "type": "object",
        "properties": {
          "amount": {
            "type": "number",
            "format": "double",
            "description": "Revenue amount in Merchant's reporting currency."
          },
          "amountUsd": {
            "type": "number",
            "format": "double",
            "description": "Revenue amount in USD."
          },
          "currency": {
            "description": "Merchant's reporting currency.",
            "type": "object"
          }
        }
      },
      "paymentCount": {
        "type": "integer",
        "description": "The number of approved payments for the customer."
      },
      "paymentToken": {
        "type": "string",
        "description": "A write-only payment token; if supplied, it will be converted into a\npayment instrument and be set as the `defaultPaymentInstrument`. The\nvalue of this property will override the `defaultPaymentInstrument`\nin the case that both are supplied. The token may only be used once\nbefore it is expired.\n"
      },
      "primaryAddress": {
        "type": "object",
        "properties": {
          "address": {
            "type": "string",
            "description": "The contact street address."
          },
          "address2": {
            "type": "string",
            "description": "The contact street address (second line)."
          },
          "city": {
            "type": "string",
            "description": "The contact city."
          },
          "country": {
            "type": "string",
            "description": "The contact country ISO Alpha-2 code."
          },
          "emails": {
            "type": "array",
            "description": "The list of emails.",
            "items": {
              "type": "object",
              "required": [
                "label",
                "value"
              ],
              "properties": {
                "label": {
                  "type": "string",
                  "description": "The email label."
                },
                "primary": {
                  "type": "boolean",
                  "description": "True if email is primary."
                },
                "value": {
                  "type": "string",
                  "format": "email",
                  "description": "The email value."
                }
              }
            }
          },
          "firstName": {
            "type": "string",
            "description": "The contact first name."
          },
          "hash": {
            "type": "string",
            "description": "A hash that can be used to compare multiple contacts for identical attribute values."
          },
          "lastName": {
            "type": "string",
            "description": "The contact last name."
          },
          "organization": {
            "type": "string",
            "description": "The contact organization."
          },
          "phoneNumbers": {
            "type": "array",
            "description": "The list of phone numbers.",
            "items": {
              "type": "object",
              "required": [
                "label",
                "value"
              ],
              "properties": {
                "label": {
                  "type": "string",
                  "description": "The phone label."
                },
                "primary": {
                  "type": "boolean",
                  "description": "True if phone is primary."
                },
                "value": {
                  "type": "string",
                  "description": "The phone value."
                }
              }
            }
          },
          "postalCode": {
            "type": "string",
            "description": "The contact postal code."
          },
          "region": {
            "type": "string",
            "description": "The contact region (state)."
          }
        }
      },
      "revision": {
        "type": "integer",
        "description": "The number of times the customer data has been modified.\nThe revision is useful when analyzing webhook data to determine if the change takes precedence over the current representation.\n"
      },
      "tags": {
        "type": "array",
        "description": "A list of customer's tags.",
        "items": {
          "type": "object",
          "description": "Tag.",
          "required": [
            "name"
          ],
          "properties": {
            "_links": {
              "type": "array",
              "description": "The links related to resource.",
              "items": {
                "type": "object"
              }
            },
            "createdTime": {
              "description": "The tag's created time.",
              "type": "object"
            },
            "id": {
              "description": "The tag's identifier string.",
              "type": "object"
            },
            "name": {
              "type": "string",
              "description": "The tag is unique name, which is case-insensitive."
            },
            "updatedTime": {
              "description": "The tag's updated time.",
              "type": "object"
            }
          }
        }
      },
      "updatedTime": {
        "description": "The customer updated time.",
        "type": "object"
      },
      "websiteId": {
        "description": "The website's ID.",
        "type": "object"
      }
    }
  }
}