> ## Documentation Index
> Fetch the complete documentation index at: https://docs.techfootintl.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Meters

> Retrieve meters registered in the workspace. Filter by meter number, status, or multiplier factor. `status: "InActive"` means available (unassigned); `status: "Active"` means assigned to a subscription.



## OpenAPI

````yaml POST /billspree/meters/get-meters
openapi: 3.1.0
info:
  title: Billspree API
  description: REST API for Billspree — billing, AR management, and workspace operations.
  version: 1.0.0
servers:
  - url: https://{workspace}.spreesuite.com
    variables:
      workspace:
        default: your-workspace
        description: Your organization's subdomain (e.g. demo → demo.spreesuite.com)
security:
  - apiKeyAuth: []
paths:
  /billspree/meters/get-meters:
    post:
      tags:
        - Usage
      summary: Get Meters
      description: >-
        Retrieve meters registered in the workspace. Filter by meter number,
        status, or multiplier factor. `status: "InActive"` means available
        (unassigned); `status: "Active"` means assigned to a subscription.
      operationId: getMeters
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetMetersRequest'
            example:
              method: Retrieve
              action: Retrieve Meters
              apiVersion: v2
              number: null
              status: null
              mfNo: null
              page: null
      responses:
        '200':
          description: Meters retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetMetersResponse'
              example:
                success: true
                statusCode: 200
                message: Request Succeeded.
                error: null
                data:
                  meters:
                    meters:
                      - number: 2
                        mf: 1
                        status: Active
                        purchaseDate: 20260519
                        meterHealth: ok
                        meterType: Single Phase
                    page: null
components:
  schemas:
    GetMetersRequest:
      type: object
      required:
        - method
        - action
        - apiVersion
      properties:
        method:
          type: string
          description: Always `"Retrieve"`
          example: Retrieve
        action:
          type: string
          description: Always `"Retrieve Meters"`
          example: Retrieve Meters
        apiVersion:
          type: string
          description: Always `"v2"`
          example: v2
        number:
          type: integer
          nullable: true
          description: Filter by specific meter number
        status:
          type: string
          nullable: true
          description: Filter by status — `"Active"` or `"InActive"`
        mfNo:
          type: integer
          nullable: true
          description: Filter by multiplier factor number
        page:
          type: object
          nullable: true
          description: 'Pagination — `{ "pageNumber": 0, "size": 10 }`. `null` returns all'
    GetMetersResponse:
      type: object
      properties:
        success:
          type: boolean
        statusCode:
          type: integer
        message:
          type: string
        error:
          nullable: true
        data:
          type: object
          properties:
            meters:
              type: object
              properties:
                meters:
                  type: array
                  items:
                    $ref: '#/components/schemas/Meter'
                page:
                  nullable: true
    Meter:
      type: object
      properties:
        number:
          type: integer
          description: >-
            Unique meter number — used as the identifier for assignment and
            reading submission
        mf:
          type: number
          description: >-
            Multiplier factor — applied to raw readings at bill calculation time
            to get billed units
        status:
          type: string
          description: >-
            `"Active"` = assigned to a subscription, `"InActive"` = available
            for assignment
        purchaseDate:
          type: integer
          description: Purchase date in `YYYYMMDD` format
        meterHealth:
          type: string
          description: Health status — e.g. `"ok"`
        meterType:
          type: string
          description: Type of meter — e.g. `"Single Phase"`
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: >-
        Auth token returned from the login endpoint. Send as: `Authorization:
        <token>` (no Bearer prefix)

````