action square_list_customer_groups {
  label: "ListCustomerGroups"
  description: "Retrieves the list of customer groups of a business."
  provider: square
  method: GET
  path: "/v2/customers/groups"
  encoding: json
  input: {
    type: "object"
    properties: {
      cursor: {
        type: "string"
      }
      limit: {
        type: "integer"
      }
    }
    additionalProperties: false
  }
  output: {
    type: "object"
    description: "Defines the fields that are included in the response body of\na request to the [ListCustomerGroups](https://developer.squareup.com/reference/square_2021-08-18/customer-groups-api/list-customer-groups) endpoint.\n\nEither `errors` or `groups` is present in a given response (never both)."
    properties: {
      cursor: {
        type: "string"
        description: "A pagination cursor to retrieve the next set of results for your\noriginal query to the endpoint. This value is present only if the request\nsucceeded and additional results are available.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination)."
      }
      errors: {
        type: "array"
        description: "Any errors that occurred during the request."
        items: {
          type: "object"
          description: "Represents an error encountered during a request to the Connect API.\n\nSee [Handling errors](https://developer.squareup.com/docs/build-basics/handling-errors) for more information."
          required: ["category", "code"]
          properties: {
            category: {
              type: "string"
              description: "The high-level category for the error."
            }
            code: {
              type: "string"
              description: "The specific code of the error."
            }
            detail: {
              type: "string"
              description: "A human-readable description of the error for debugging purposes."
            }
            field: {
              type: "string"
              description: "The name of the field provided in the original request (if any) that\nthe error pertains to."
            }
          }
        }
      }
      groups: {
        type: "array"
        description: "A list of customer groups belonging to the current seller."
        items: {
          type: "object"
          description: "Represents a group of customer profiles. \n\nCustomer groups can be created, be modified, and have their membership defined using \nthe Customers API or within the Customer Directory in the Square Seller Dashboard or Point of Sale."
          required: ["name"]
          properties: {
            created_at: {
              type: "string"
              description: "The timestamp when the customer group was created, in RFC 3339 format."
            }
            id: {
              type: "string"
              description: "A unique Square-generated ID for the customer group."
            }
            name: {
              type: "string"
              description: "The name of the customer group."
            }
            updated_at: {
              type: "string"
              description: "The timestamp when the customer group was last updated, in RFC 3339 format."
            }
          }
        }
      }
    }
  }
}