Skip to main content
POST
/
billspree
/
meters
/
get-meters
Get Meters
curl --request POST \
  --url https://{workspace}.spreesuite.com/billspree/meters/get-meters \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "method": "Retrieve",
  "action": "Retrieve Meters",
  "apiVersion": "v2",
  "number": null,
  "status": null,
  "mfNo": null,
  "page": null
}
'
{
  "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
    }
  }
}

Authorizations

Authorization
string
header
required

Auth token returned from the login endpoint. Send as: Authorization: <token> (no Bearer prefix)

Body

application/json
method
string
required

Always "Retrieve"

Example:

"Retrieve"

action
string
required

Always "Retrieve Meters"

Example:

"Retrieve Meters"

apiVersion
string
required

Always "v2"

Example:

"v2"

number
integer | null

Filter by specific meter number

status
string | null

Filter by status — "Active" or "InActive"

mfNo
integer | null

Filter by multiplier factor number

page
object | null

Pagination — { "pageNumber": 0, "size": 10 }. null returns all

Response

200 - application/json

Meters retrieved successfully

success
boolean
statusCode
integer
message
string
error
unknown
data
object