v10

latestOpenAPI 3.0.1raw.githubusercontent.com2025-12-033223581.2 MB

CustomField

Retrieve CustomField

Retrieve all Custom Fields added at Organizational level for the entities that support them.

get/organizations/{orgId}/customfields

Path parameters

orgIdstring required

UUID of the Organization. The Organization represents your company as a direct customer of the m3ter service.

Response

Return the CustomFields

idstring required

The UUID of the entity.

versioninteger

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.

organizationobject

CustomFields added to the Organization.

accountobject

CustomFields added to Account entities.

accountPlanobject

CustomFields added to accountPlan entities.

meterobject

CustomFields added to Meter entities.

productobject

CustomFields added to Product entities.

planTemplateobject

CustomFields added to planTemplate entities.

planobject

CustomFields added to Plan entities.

aggregationobject

CustomFields added to simple Aggregation entities.

compoundAggregationobject

CustomFields added to Compound Aggregation entities.

contractobject

CustomFields added to Contract entities.

dtCreatedstring date-time

The DateTime when the Organization was created (in ISO-8601 format).

dtLastModifiedstring date-time

The DateTime when a custom field was last modified - created, modified, or deleted - for the Organization (in ISO-8601 format).

createdBystring

The id of the user who created this custom field.

lastModifiedBystring

The id of the user who last modified this custom field.

Example response

{
  "id": "81c49a54-dfcd-4da5-bbf3-d2885ec025dd",
  "version": 4,
  "organization": {
    "Org Example 2": "Sample text 2.",
    "Org Example 1": "Sample text. "
  },
  "product": {
    "Product CF Example": 42
  },
  "account": {},
  "accountPlan": {
    "New CF Test": "Test Value"
  },
  "meter": {},
  "planTemplate": {},
  "plan": {},
  "aggregation": {},
  "compoundAggregation": {}
}