--- title: "Retrieve Meter" method: GET path: "/organizations/{orgId}/meters/{id}" tags: ["Meter"] --- # Retrieve Meter `GET /organizations/{orgId}/meters/{id}` Retrieve the Meter with the given UUID. ## Path parameters - `orgId` string, required - `id` string, required ## Response `200` Return the requested Meter - MeterResponse - `id` string, required — The UUID of the entity. - `version` integer — The version number: - **Create:** On initial Create to insert a new entity, the version is set at 1 in the response. - **Update:** On successful Update, the version is incremented by 1 in the response. - `customFields` object — User defined fields enabling you to attach custom data. The value for a custom field can be either a string or a number. If `customFields` can also be defined for this entity at the Organizational level,`customField` values defined at individual level override values of `customFields` with the same name defined at Organization level. See [Working with Custom Fields](https://www.m3ter.com/docs/guides/creating-and-managing-products/working-with-custom-fields) in the m3ter documentation for more information. - `productId` string — UUID of the Product the Meter belongs to. *(Optional)* - if blank, the Meter is global. - `groupId` string — UUID of the MeterGroup the Meter belongs to. *(Optional)*. - `name` string — Descriptive name for the Meter. - `code` string — Code of the Meter - unique short code used to identify the Meter. - `dataFields` DataField[] — Used to submit categorized raw usage data values for ingest into the platform - either numeric quantitative values or non-numeric data values. At least one required per Meter; maximum 15 per Meter. - `category` 'WHO' | 'WHERE' | 'WHAT' | 'OTHER' | 'METADATA' | 'MEASURE' | 'INCOME' | 'COST', required — The field type, which defines the type of data collected in the field. * **Who.** String. Use to collect usage data about an individual or organization - data events that answer a "Who" question, such as, "Who or which organization logged-in to the service?", "Who was contacted?", and so on. * **What.** String. Use to collect usage data about some object or thing, whether it be a physical object in the real world or something in a virtual context. * **Where.** String. Use to collect usage data about a location - where something happened, whether in physical geographical space or a virtual space. * **Measure.** Numeric. Use in a general way to collect quantitative usage data. * **Metadata.** String. *(Max. 256 characters).* Use for high-cardinality fields that you don't intend to segment when you aggregate the data. * **Income.** Numeric. Use to collect usage data associated with income. * **Cost.** Numeric. Use to collect usage data associated with costs. * **Other.** String. Use to collect textual usage not applicable to Who, What, or Where events. - `code` string, required — Short code to identify the field **NOTE:** Code has a maximum length of 80 characters and can only contain letters, numbers, underscore, and the dollar character, and must not start with a number. - `name` string, required — Descriptive name of the field. - `unit` string — The units to measure the data with. Should conform to *Unified Code for Units of Measure* (UCUM). Required only for numeric field categories. - `derivedFields` DerivedField[] — Used to submit usage data values for ingest into the platform that are the result of a calculation performed on `dataFields`, `customFields`, or system `Timestamp` fields. Raw usage data is not submitted using `derivedFields`. Maximum 15 per Meter. *(Optional)*. - `category` 'WHO' | 'WHERE' | 'WHAT' | 'OTHER' | 'METADATA' | 'MEASURE' | 'INCOME' | 'COST', required — The field type, which defines the type of data collected in the field. * **Who.** String. Use to collect usage data about an individual or organization - data events that answer a "Who" question, such as, "Who or which organization logged-in to the service?", "Who was contacted?", and so on. * **What.** String. Use to collect usage data about some object or thing, whether it be a physical object in the real world or something in a virtual context. * **Where.** String. Use to collect usage data about a location - where something happened, whether in physical geographical space or a virtual space. * **Measure.** Numeric. Use in a general way to collect quantitative usage data. * **Metadata.** String. *(Max. 256 characters).* Use for high-cardinality fields that you don't intend to segment when you aggregate the data. * **Income.** Numeric. Use to collect usage data associated with income. * **Cost.** Numeric. Use to collect usage data associated with costs. * **Other.** String. Use to collect textual usage not applicable to Who, What, or Where events. - `code` string, required — Short code to identify the field **NOTE:** Code has a maximum length of 80 characters and can only contain letters, numbers, underscore, and the dollar character, and must not start with a number. - `name` string, required — Descriptive name of the field. - `unit` string — The units to measure the data with. Should conform to *Unified Code for Units of Measure* (UCUM). Required only for numeric field categories. - `calculation` string, required — The calculation used to transform the value of submitted `dataFields` in usage data. Calculation can reference `dataFields`, `customFields`, or system `Timestamp` fields. *(Example: datafieldms datafieldgb)* - `dtCreated` string, date-time — The DateTime when the meter was created *(in ISO-8601 format)*. - `dtLastModified` string, date-time — The DateTime when the meter was last modified *(in ISO-8601 format)*. - `createdBy` string — The id of the user who created this meter. - `lastModifiedBy` string — The id of the user who last modified this meter. ## Other responses - `4XX` — Error message - `5XX` — Error message --- [API](https://skmtc.net/m3ter-com/apis/m3ter-api.md) · [All operations](https://skmtc.net/m3ter-com/apis/m3ter-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/m3ter-com/m3ter-api/revisions/ac93d1a9e6d9/schema)